DitsGetActIndex - Return the index of the current action
Function
Return the index of the current action
Description
Returns the index of the current action. This value should only
be used as an argument to DitsSignalByIndex, DitsKillByIndex or
when creating an argument structure to be used to kick this action,
if this action is a spawned action. In that case, the argument
item should be named KickByIndex.
Language
C
Call
(long int) = DitsGetActIndex ()
Parameters
(">" input, "!" modified, "W"
workspace, "<" output)
none
Include files
DitsFix.h
Return value
The index of the current action.
External functions used
none
External values used
DitsTask - Details of the current task
Prior requirements
None, but if not called from an action routine, it's value is invalid.
See Also
The Dits Specification Document, DitsSignalByIndex(3),
DitsKillByIndex(3), DitsSpawnKickArg(3).
Support
Tony Farrell, AAO
Click here for the DRAMA home page and
here for the AAO home page.
For more information, contact tony.farrell@mq.edu.au