Creates a group in a locked (collapsed) mode, and sets the group’s symbol in the Information tree.
HRESULT CreateLockedGroupEx(
[in] BSTR GroupName,
[in, defaultvalue(0)] long ParentGroupID,
[in, defaultvalue(0)] GroupIconIndex Index,
[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.
Index – Determines the symbol used to represent the group. The symbol can be one of the following options:
GROUP_PLAIN =
0
GROUP_SHP =
1
GROUP_SDE =
2
GROUP_DXF =
3
GROUP_ORA =
4
GROUP_ASC =
5
GROUP_BMP =
6
GROUP_BUILDING =
7
GROUP_FLY =
8
GROUP_LINE =
9
GROUP_LINEOFSIGHT =
10
GROUP_OBJ =
11
GROUP_POINT =
12
GROUP_POLYGON =
13
GROUP_TXT =
14
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 permission to work with this interface. |