The GetGroupVisibility method returns the visibility status of the objects in the group. The possible results are, all objects in the group, including the nested items, are visible on the terrain, not visible, or some objects are visible and some are not.
HRESULT GetGroupVisibility(
[in] long GroupID,
[out, retval] int *pVal)
Parameters:
GroupID – The group whose visibility status you are about to get. You cannot use zero to specify the root. 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.
pVal – Once the method call is returned, pVal contains the int return value specifying the visibility status of the objects in the group. The following are the possible values:
0 – All the objects in the group are not visible (unchecked in TerraExplorer Information Tree).
1 – All the objects in the group are visible (checked in TerraExplorer Information Tree)
2 – Some of the objects in the group are visible and some are not (gray check mark in TerraExplorer Information Tree).
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_NOLICENSE |
You are running TerraExplorer Basic and therefore do not have permission to work with this interface. |
|
TE_E_INFOTREE_CANTUSEROOT |
Can not use tree root for this operation. |