The SetClientDataEx method enables you to store a text string
for the purpose of describing the group or any other purpose. You
can store several text strings by using different Namespaces. You
can read this string by using the “GetClientDataEx” method.
Note: The SetClientData method stores the text string in the
global Namespace. You can access the global namespace by passing an
empty string for the Namespace parameter.
HRESULT SetClientDataEx(
[in] long GroupID,
[in] BSTR Namespace,
[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.
Namespace – The identifier of the text string. You can store several text strings in the group by using different namespaces. You must use the correct namespace when accessing the client data using the “GetClientDataEx” method.
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_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 |