Home > Working with SGWorld > ProjectTree (IProjectTree6) > GetClientData

GetClientData

The GetClientData method retrieves the text string stored in a specific Namespace.

 

JavaScript

 

GetClientData(ItemID, Namespace)

 

C#

 

string GetClientData(

      int ItemID,

      string Namespace)

 

C++

 

HRESULT GetClientData(

      LONG_PTR    ItemID,

      BSTR  Namespace,

      BSTR *      ClientData) 

 

Parameters:

ItemID

The item whose client data you retrieve

Namespace

The identifier of the text string.

Return Value

ClientData

A text string.

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.