GetItemName
Returns the name of a specific item in the Project Tree using its ID.
Supported by TerraExplorer Viewer.
|
JavaScript |
|
|
GetItemName( ID) |
|
|
C# |
|
|
string GetItemName( string ID) |
|
|
C++ |
|
|
HRESULT GetItemName( BSTR ID, BSTR * ItemText) |
|
Parameters
ID
The ID of the item whose name you are looking for.
Return Value
ItemText
The name of the item as it appears 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. |
Remarks
This method can be used while traversing the Project Tree to obtain the real names of the items in the Tree.