LockGroup

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.

JavaScript

LockGroup(

GroupID,

bLock)

void LockGroup(

string GroupID,

bool bLock)

C++

HRESULT LockGroup(

BSTR GroupID,

VARIANT_BOOL bLock)

Parameters

GroupID

The group whose lock status is changed. You can obtain the GroupID by one of the following methods:

· Create the group using IProjectTree80.CreateGroup.

· Find the group, if you know the name, using IProjectTree80.FindItem.

· Traverse the Tree using IProjectTree80 methods such as GetNextItem, until you come to the desired GroupID.

bLock

A Boolean that determines whether the group is locked or unlocked.

Exceptions

HRESULT can return any of the values listed in the HRESULT Return Values list, as well as the following values:

TE_E_INFOTREE_PARENTNOTGROUP	The group ID entered does not represent a valid group in the Project Tree.
TE_E_INFOTREE_ITEMNOTGROUP	The item entered is not a group and therefore cannot be used as a group.
TE_E_INFOTREE_CANTUSEROOT	Cannot use Tree root for this operation
TE_E_INFOTREE_ITEMISGROUP	Item ID is a group so an object cannot be retrieved.