Retrieves the activation action assigned for the specified group.
HRESULT GetActivationCode(
[in] long GroupID,
[out] VARIANT* actioncodeACode,
[out] VARIANT* intActivationParam)
Parameters:
GroupID – Refers to the group whose activation action is retrieved. You can obtain the GroupID by one of the following methods:
Create the group using IInformationTree5::CreateGroup.
Find the group, if you know the name, using IInformationTree5::FindItem.
Traverse the Tree using IInformationTree5 methods such as GetNextItem(), until you come to the desired GroupID.
actioncodeACode – An enum that determines how you fly to the group. The following are the possible ActionCode enumeration values for this code:
AC_FLYTO = 0
AC_CIRCLEPATTERN = 1
AC_OVALPATTERN = 2
AC_LINEPATTERN = 3
AC_ARCPATTERN = 4
AC_FOLLOWBEHIND = 5
AC_FOLLOWABOVE = 6
AC_FOLLOWBELOW = 7
AC_FOLLOWRIGHT = 8
AC_FOLLOWLEFT = 9
AC_FOLLOWBEHINDANDABOVE = 10
AC_FOLLOWCOCKPIT = 11
AC_FOLLOWFROMGROUND = 12
AC_JUMP = 14
intActivationParam – Reserved always pass -1 (minus one). Currently not used.
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_ITEMNOTGROUP |
The item entered is not a group and therefore cannot get activation code. |
TE_E_NOLICENSE |
You are running TerraExplorer Viewer and therefore do not have permission to work with this interface. |
TE_E_INFOTREE_CANTUSEROOT |
Can not use tree root for this operation |