The GetClientData method retrieves the XML string describing the group’s attribute data. This information is available for general use in your application. TerraExplorer uses this property to store general information for groups that were loaded from a GIS Layer.
HRESULT GetClientData(
[in] long GroupID,
[out, retval] BSTR* ClientData)
Parameters:
GroupID – The group whose client data you retrieve. You can obtain the GroupID by one of the following methods:
Create the group using IInformationTree5::CreateGroup.
Find the group, if you know the name, using IInformationTree5::FindItem.
Traverse the Tree using IInformationTree5 methods such as GetNextItem(), until you come to the desired GroupID.
ClientData – An XML string, see method’s description.
Return Values:
The return value obtained from the returned HRESULT can be one of the following:
|
Return value |
Meaning |
|
S_OK |
Success. |
|
E_FAIL |
Catastrophic failure. |
|
TE_E_MPTNOTLOADED |
An MPT file must be loaded in TerraExplorer for this method to work. |
|
TE_E_INFOTREE_ITEMNOTGROUP |
The item entered is not a group and therefore cannot get client data. |
|
TE_E_NOLICENSE |
You are running TerraExplorer Viewer and therefore do not have permission to work with this interface. |
|
TE_E_INFOTREE_CANTUSEROOT |
Can not use tree root for this operation |