This method stores a text string in the group global namespace. To avoid overwriting other information stored in the global namespace, and to protect your information, it's recommended to use the SetClientDataEx method (See: SetClientDataEx) for storing information in a private Namespace.
HRESULT SetClientData(
[in] long GroupID,
[in] BSTR ClientData)
Parameters:
GroupID – The group whose client data we set. 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 – A text 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 set 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 |