DitsPutObeyHandler - Sets a new handler routine for the next reschedule.

Function

Sets a new handler routine for the next reschedule.

Description

Called by an Action routine to set the routine to be called on the next reschedule of this action.

Simply saves the routine.

The old name DitsPutHandler should be replaced by DitsPutObeyHandler in new code.

Language

C

Call

(DitsActionRoutineType) = DitsPutObeyHandler (routine, status)

Parameters

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

>routineDitsActionRoutineTypeThe handler routine. See the Dits documentation for details.
!statusStatusType *Modified status.

Function Prototypes Used

typedef void (*DitsActionRoutineType)(StatusType *status);

Parameters

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

!statusStatusType *Modified status. The action obey handler function should set status bad when it fails - this status will be returned to the task which sent the obey message.

Include files

DitsFix.h

External functions used

None

External values used

DitsTask - Details of the current task

Return value

The previous obey handler.

Prior requirements

Can only be called from a Dits application routine

See Also

The Dits Specification Document, DitsPutActions(3), DitsPutKickHandler(3), DitsPutDefObeyHandler(3).

Support

Tony Farrell, AAO

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

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