DitsGetSigArg - Fetch the argument supplied to this action by a DitsSignal...Ptr call.

Function

Fetch the argument supplied to this action by a DitsSignal...Ptr call.

Description

The DitsSignalByNamePtr() and DitsSignalByIndexPtr() allow you to supply a pointer as one of the arguments. This function will return that pointer value or 0 if this entry was not triggered by such a signal call.

Note, this function is implemented as a macro.

Language

C

Call

(void *) = DitsGetSigArg ()

Include files

DitsFix.h

Function value

The signal argument to the action. If no signal argument was supplied, then 0 will be returned.

External functions used

None

External values used

DitsTask - Details of the current task

Prior requirements

Can only be called from a Dits application routine or a user interface response routine

See Also

The Dits Specification Document, DitsGetArgument(3), DitsSignalByNamePtr(3), DitsSignalByIndexPtr(3).

Support

Tony Farrell, AAO

Click here for the DRAMA home page and here for the AAO home page.

 For more information, contact tjf@aaoepp.aao.gov.au