GetItemByPath method

Returns an item in a Room, using a path as input.

Syntax

C++

HRESULT GetItemByPath(
   BSTR Path,
   IERUItem** ppItem)

Scripting languages
Set item = Object.GetItemByPath(
   Path as String)

Parameters

Path

The full path of the requested item.

ppItem

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

Return value

C++

The return code.
Scripting languages

An IERUItem interface pointer to the requested object.

Remarks

You can use GetItemByPath only to get principal items. You cannot use it to get Polls, Comments, Votes, or embedded Topics. You can get a Principal Item's path from it's Path property.

The following examples show paths for several eRoom items:

  • "/" is the path for a Room's home page.

  • "/myfolder" is the path for a Folder Page named myfolder that is contained by a Room's home page.

  • "/myfolder/discussion one" is the path for a Discussion Page contained by the Folder Page shown in the previous example.

  • If an item's name contains a / (slash) or a \ (backslash), the character is escaped with a \ (backslash). For example, the name for a Folder Page named 7/3/98 should appear as "7\/3\/98" and the path for a Folder Page named Contain\Char should appear as "Contain\\Char."

Home
 
Applies to
IERURoom