GetFacilityEx method

**This method is obsolete in V. 7.**

Returns a Facility.

Syntax

C++

HRESULT 
 GetFacility(

   BSTR Facility, 

   ERUParameterType 
 FacilityParameter, 

   BSTR User, 

   ERUParameterType UserParameter, 

   IERUFacility** ppFacility)

Scripting languages

Set 
 Facility = SvrManager.GetFacility(

   Facility as String,

   FacilityParameter as ERUParameterType,

   User as String,

   UserParameter as ERUParameterType)

Parameters

Facility

Either the eRoom ID of the Facility or the name of a Facility as it appears in its URL.

FacilityParameter

Indicates whether Facility specifies a name or eRoom ID. For further information see ERUParameterType.

User

The eRoom login name or ID of the User logging in. If UserParameter is erParamTypeName and an empty string is provided, or UserParameter is erParamTypeID and the value "1" is provided, the caller is logged in as the built-in facility administrator.

UserParameter

Indicates whether User specifies a login name or ID. For further information see ERUParameterType.

ppFacility

Upon return, an IERUFacility interface pointer to the requested Facility.

Return value

C++

The return code.

Scripting languages

An IERUFacility interface pointer to the requested Facility.

Remarks

GetFacilityEx is more flexible than GetFacility because it lets you access a facility by specifying either the name or the id for the facility and user.

Because GetFacilityEx forces the caller to log in, it also establishes a user context for the session. Once a user context has been established for a facility, you can continue to access the facility without supplying the login password again.

The facility's URL name is the shortened version of the descriptive name that appears in the URL for a facility. The URLName property returns a facility's URL name.

The ID property returns the ID for a Member or Facility. IDs are not available anywhere in the eRoom interface; they are only available through the API.

Home

Applies to
IERUSvrManager