CreateLockedGroup

Creates a group in a “locked” (collapsed) mode. When locked, TerraExplorer Viewer users cannot expand the group to view its contents.

 

JavaScript
CreateLockedGroup(       GroupName,       ParentGroupID = 0)

 

C#
int CreateLockedGroup(       string GroupName,       int ParentGroupID = 0)

 

C++
HRESULT CreateLockedGroup(       BSTR GroupName,       LONG_PTR ParentGroupID,       LONG_PTR * pVal)

Parameters

GroupName

Name assigned to the group being created.

ParentGroupID

The Project Tree group in which the line of sight object is created. If it is set to zero, the object is created under the root. You can obtain the GroupID by one of the following methods:

§   Create the group using IProjectTree6.CreateGroup.

§  Find the group, if you know the name, using IProjectTree6.FindItem.

§  Traverse the Tree using IProjectTree6 methods such as GetNextItem(), until you come to the desired GroupID.

Return Value

pVal

The ID of the locked group being created.

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	Can not use tree root for this operation
TE_E_INFOTREE_ITEMISGROUP	ItemID is a group so an object cannot be retrieved.

Remarks

It is recommended to use this feature to combine multiple objects into one virtual entity.