GetItemName

Returns the name of a certain item using its Project Tree ItemID.

Supported by TerraExplorer Viewer.

 

JavaScript

 

GetItemName(

       ItemID)

 

C#

 

string GetItemName(

       int ItemID)

 

C++

 

HRESULT GetItemName(

       LONG_PTR ItemID,

       BSTR * ItemText) 

Parameters

ItemID

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

Can not use tree root for this operation

TE_E_INFOTREE_ITEMISGROUP

ItemID is a group so an object cannot be retrieved.

Remarks:

This method can be used while traversing the tree to obtain the real names of the items in the tree.