Galactix Home | Main Page | Class Hierarchy | Data Structures | Function List

IVenue Interface Reference

The IVenue object. More...

#include <tsssx.idl>

Inherits IDispatch.


Public Methods

HRESULT ToString ([out, retval] BSTR *pVal)
 Get a String representation of this object. More...

HRESULT Name ([out, retval] BSTR *pVal)
 Get the Name property of this object as a String. More...

HRESULT ID ([out, retval] long *pVal)
 Get the ID property of this object as a long. More...

HRESULT Comment ([out, retval] BSTR *pVal)
 Get the Comment property of this object as a String. More...

HRESULT Description ([out, retval] BSTR *pVal)
 Get the Description property of this object as a String. More...

HRESULT Directions ([out, retval] BSTR *pVal)
 Get the Directions property of this object as a String. More...

HRESULT ImagePathname ([out, retval] BSTR *pVal)
 Get the ImagePathname property of this object as a String. More...

HRESULT LogoPathname ([out, retval] BSTR *pVal)
 Get the LogoPathname property of this object as a String. More...

HRESULT Availability ([out, retval] IAvailability **pVal)
 Get the IAvailabiity object associated with this object. More...

HRESULT getNumOfContacts ([out, retval] long *plNum)
 Get the number of IContact's for the venue. More...

HRESULT getNumOfSponsors ([out, retval] long *plNum)
 Get the number of ISponsor's for the venue. More...

HRESULT getContacts ([out, retval] IContactCollection **ppICollection)
 Get a collection of all the IContact's for the venue. More...

HRESULT getSponsors ([out, retval] ISponsorCollection **ppICollection)
 Get a collection of all the ISponsor's for the venue. More...

HRESULT getMasterSchedules ([out, retval] IMasterScheduleCollection **ppICollection)
 Get a collection of all the IMasterSchedule's in the project. More...


Detailed Description

The IVenue object.

The IVenue object is the venue (a.k.a. field, court, rink, etc) where the game takes place. Do not create this object directly, instead use one of the getVenue() or getVenues() methods from the IProject, ILeague, ITeam, IGame, or ITournamentSchedule object.

Program ID: TSSSX.Venue

Example:

    var eVenues = new Enumerator(Project.getVenues());
    for (; !eVenues.atEnd(); eVenues.moveNext())
    {
        oVenue = eVenues.item();

        // do something with the IVenue object
        Response.Write("How to get to '" + oVenue.Name + "': " + oVenue.Directions);
    }

See also:
IProject, ILeague, ITeam, IGame, ITournamentSchedule


Member Function Documentation

HRESULT IVenue::Availability [out, retval] IAvailability **    pVal
 

Get the IAvailabiity object associated with this object.

Example:

    if (obj.Availability.AlwaysAvailable)
    {
        Response.WriteLine("The object " + obj.Name + " is always available for game play.");
    }

HRESULT IVenue::Comment [out, retval] BSTR *    pVal
 

Get the Comment property of this object as a String.

Example:

    var sComment = obj.Comment;

HRESULT IVenue::Description [out, retval] BSTR *    pVal
 

Get the Description property of this object as a String.

Example:

    var sText = "The description is: '" + obj.Description + "'";

HRESULT IVenue::Directions [out, retval] BSTR *    pVal
 

Get the Directions property of this object as a String.

Example:

    var sText = "How to get here: " + venue.Directions;

HRESULT IVenue::ID [out, retval] long *    pVal
 

Get the ID property of this object as a long.

Example:

    var iID = obj.ID;

HRESULT IVenue::ImagePathname [out, retval] BSTR *    pVal
 

Get the ImagePathname property of this object as a String.

If specified, the ImagePathname is the filename of the image associated with this object. This may not point to the actual file on the hard drive. For example, during the website generation all the images are copied to the ProjectName-Web\images folder. The example below would point to the website generated image file.

Example:

    var sImg = "";
    if (obj.ImagePathname != "")
        sImg = "<img src=\"images/\" + obj.ImagePathname + "\">";

HRESULT IVenue::LogoPathname [out, retval] BSTR *    pVal
 

Get the LogoPathname property of this object as a String.

If specified, the LogoPathname is the filename of the logo image associated with this object. This may not point to the actual file on the hard drive. For example, during the website generation all the images are copied to the ProjectName-Web\images folder. The example below would point to the website generated image file.

Example:

    var sImg = "";
    if (obj.ImagePathname != "")
        sImg = "<img src=\"images/\" + obj.LogoPathname + "\">";

HRESULT IVenue::Name [out, retval] BSTR *    pVal
 

Get the Name property of this object as a String.

Example:

    var sName = obj.Name;

HRESULT IVenue::ToString [out, retval] BSTR *    pVal
 

Get a String representation of this object.

Example:

    var sImplicit = "The object '" + obj + "' ToString property was called implicitly.";
    var sDirect = "The object '" + obj.ToString + "' ToString property was called directly.";

HRESULT IVenue::getContacts [out,retval] IContactCollection **    ppICollection
 

Get a collection of all the IContact's for the venue.

Returns:
Returns a IContactCollection of all the IContact's for the venue.
Example:
    var obj;
    var eItems = new Enumerator(venue.getContacts());
    for (; !eItems.atEnd(); eItems.moveNext())
    {
        obj = eItems.item();
        // do something with the obj
    }
See also:
IContact, IContactCollection

HRESULT IVenue::getMasterSchedules [out,retval] IMasterScheduleCollection **    ppICollection
 

Get a collection of all the IMasterSchedule's in the project.

Returns:
Returns a IMasterScheduleCollection of all the IMasterSchedule's in the project.
Example:
    var obj;
    var eItems = new Enumerator(venue.getMasterSchedules());
    for (; !eItems.atEnd(); eItems.moveNext())
    {
        obj = eItems.item();
        // do something with the obj
    }
See also:
IMasterSchedule, IMasterScheduleCollection

HRESULT IVenue::getNumOfContacts [out,retval] long *    plNum
 

Get the number of IContact's for the venue.

Returns:
Returns the number of IContact's for the venue.
Example:
    var iNum = venue.getNumOfContacts();

HRESULT IVenue::getNumOfSponsors [out,retval] long *    plNum
 

Get the number of ISponsor's for the venue.

Returns:
Returns the number of ISponsor's for the venue.
Example:
    var iNum = venue.getNumOfSponsors();

HRESULT IVenue::getSponsors [out,retval] ISponsorCollection **    ppICollection
 

Get a collection of all the ISponsor's for the venue.

Returns:
Returns a ISponsorCollection of all the ISponsor's for the venue.
Example:
    var obj;
    var eItems = new Enumerator(venue.getSponsors());
    for (; !eItems.atEnd(); eItems.moveNext())
    {
        obj = eItems.item();
        // do something with the obj
    }
See also:
ISponsor, ISponsorCollection


Galactix Home | Main Page | Class Hierarchy | Data Structures | Function List

Copyright © 1996-2007, Galactix Software. All rights reserved.
Questions? Comments? Send email to support@galactix.com