Home > Working with SGWorld > ProjectTree (IProjectTree6) > GetGroupLocation
This method returns the location parameters of the specified group.
JavaScript |
|
GetGroupLocation(GroupID) |
C# |
|
IPosition6 GetGroupLocation( int GroupID) |
C++ |
|
HRESULT GetGroupLocation( LONG_PTR GroupID, IPosition6 ** pVal) |
Parameters:
GroupID
The ID of the group whose location you are about to get. 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
An IPosition6 representing the location of the queried group.
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. |