FindItem
Finds an item using a path to that item.
Supported by TerraExplorer Viewer.
|
JavaScript |
|
|
FindItem(PathName) |
|
|
C# |
|
|
string FindItem( string PathName) |
|
|
C++ |
|
|
HRESULT FindItem( BSTR PathName, BSTR * 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 an empty string if no such item was found in the Project 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 |
Cannot use Tree root for this operation |
|
TE_E_INFOTREE_ITEMISGROUP |
Item ID is a group so an object cannot be retrieved. |