GetRoomByName method

Returns a Room in a Facility.

Syntax

C++

HRESULT GetRoomByName(
   BSTR Name,
   IERURoom **ppRoom)

Scripting languages
Set room = Object.GetRoomByName(
   Name as String)

Parameters

Name

The Name of the requested Room as it appears in its URL.

ppRoom

Upon return, an IERURoom interface pointer to the requested object.

Return value

C++

The return code.
Scripting languages

An IERURoom interface pointer to the requested object.

Remarks

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

Home

Applies to
IERUFacility