GetClientData
The GetClientData method retrieves the text string stored in a specific namespace.
Note: If you call this method with _All_Namespaces_ as the value for the Namespace parameter, a string is returned with all the namespaces separated by "|".
|
JavaScript |
|
|
GetClientData(ID, Namespace) |
|
|
C# |
|
|
string GetClientData( string ID, string Namespace) |
|
|
C++ |
|
|
HRESULT GetClientData( BSTR ID, BSTR Namespace, BSTR * ClientData) |
|
Parameters
ID
The item whose client data you want to retrieve
Namespace
The identifier of the text string.
Note: If you call this method with _All_Namespaces_ as the value for the Namespace parameter, a string is returned with all the namespaces separated by "|".
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 |
Cannot use Tree root for this operation |
|
TE_E_INFOTREE_ITEMISGROUP |
Item ID is a group so an object cannot be retrieved. |