GetGroupMessageID
Returns the message set for a specific group or layer in the Project Tree using its ID.
|
JavaScript |
|
|
GetGroupMessageID( GroupID) |
|
|
C# |
|
|
string GetGroupMessageID( string GroupID) |
|
|
C++ |
|
|
HRESULT GetGroupMessageID( BSTR GroupID, BSTR* MessageID) |
|
Parameters
GroupID
The ID of the group orlayer whose name you are looking for. You can obtain the GroupID by one of the following methods:
· Create the group using IProjectTree80.CreateGroup or create the layer using ICreator80.
· Find the group or layer, if you know the name, using IProjectTree80.FindItem.
· Traverse the Tree using IProjectTree80 methods such as GetNextItem, until you come to the desired GroupID or LayerID.
Return Value
MessageID
ID of the message object.
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. |