The GetGroupColor method returns the color that is assigned to a group.
HRESULT GetGroupColor (
[in] long GroupID,
[out, retval] long *pVal)
Parameters:
GroupID – The group whose color you are seeking. You can obtain the GroupID by one of the following methods:
As a returned value from the IInformationTree5::CreateGroup method call.
If you know the name of the group, find it using IInformationTree5::FindItem.
Traverse the Tree using IInformationTree5 methods such as GetNextItem, until you come to the desired GroupID.
pVal – Once the method call is returned, pVal contains the color of the specified group.
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 be renamed. |
|
TE_E_NOLICENSE |
You are running TerraExplorer Viewer and therefore do not have permission to work with this interface. |