The method Sets a group to a “lock” (collapsed) status mode. When a group is locked, users of TerraExplorer Viewer cannot expand the group and view its contents.
HRESULT LockGroup(
[in] long GroupID,
[in] long bLock);
Parameters:
GroupID – Refers to the group whose lock status is changed. 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.
bLock – A Boolean that determines whether the group is locked or unlocked.
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 |