FindItem

Finds an item using a path to that item.

Supported by TerraExplorer Viewer.

 

JavaScript
FindItem(PathName)

 

C#
int FindItem(       string PathName)

 

C++
HRESULT FindItem(       BSTR PathName,       LONG_PTR * pVal)

 

Parameters

PathName

The exact path to the item being searched. Child items are separated by ‘\’ (i.e. “Cities\Boston”).

Return Value

pVal

The ID of the item that was found or zero if no such item was found in the tree.

Exceptions

HRESULT can return any of the values listed in the HRESULT Return Values list, as well as the following values:

TE_E_INFOTREE_PARENTNOTGROUP	The group ID entered does not represent a valid group in the project tree.
TE_E_INFOTREE_ITEMNOTGROUP	The item entered is not a group and therefore cannot be used as a group.
TE_E_INFOTREE_CANTUSEROOT	Can not use tree root for this operation
TE_E_INFOTREE_ITEMISGROUP	ItemID is a group so an object cannot be retrieved.