Creates a group in a “locked” (collapsed) mode. When locked, TerraExplorer Viewer users cannot expand the group to view its contents.
HRESULT CreateLockedGroup (
[in] BSTR GroupName,
[in, defaultvalue(0)] long ParentGroupID,
[out, retval] long *pVal)
Parameters:
GroupName – Name assigned to the group being created.
ParentGroupID – Allows the user to specify under which parent group, within the Information Tree, the group should be created. The default is set to zero meaning, if unspecified, the group is created in the root of the tree. The ParentGroupID must be a valid group id.
pVal – Once the method call is returned, pVal contains the ID of the locked group being created.
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_PARENTNOTGROUP |
The ParentGroupID entered is not a valid group id. |
|
TE_E_NOLICENSE |
You are running TerraExplorer Viewer and therefore do not have permissions to work with this interface. |
Remarks:
A locked group is a group that the user cannot expand in TerraExplorer Viewer. Usually this can be used to represent a layer (i.e. if a river on the terrain is represented by many polylines, it might be useful to put all those polylines in a locked folder and give it a name). A locked group also has a color attribute associated with it that is displayed (as part of the group icon in the tree) when the group is locked.