DitsActIndexByName - Returns the action index of an action of a specified name.

Function

Returns the action index of an action of a specified name.

Note, we only match the last entry of the name and ignore spawned actions.

Description

Language

C

Call

(long int) = DitsActIndexByName (name, index, status)

Parameters

(">" input, "!" modified, "W" workspace, "<" output)

>namechar *The name of the action to look up.
<indexlong int *The index to the action is returned here. If supplied as null, then the value is returned only.
!statusStatusType *Modified status.

Return Value

The action index or -1 on error.

Include files

DitsUtil.h

External functions used

External values used

DitsTask

Prior requirements

Can only be called from a Dits Application routine

See Also

The Dits Specification Document, DitsKillByIndex(3), DitsSignalByName(3), DitsGetActIndex(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