DitsPutRequest - Request to the fixed part for when the Action returns.

Function

Request to the fixed part for when the Action returns.

Description

Called by an Action routine to indicate to the fixed part what it should do when the action returns

Simply saves the request for action when the Action returns. Any previous request is overwritten without warning.

The default request is DITS_REQ_END, except for kick routines where the default is to reject (status != STATUS__OK) or ignore the kick.

Note, this function is implemented as a macro in C.

Language

C

Call

(Void) = DitsPutRequest (request, status)

Parameters

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

>requestDitsReqTypeThe request, one of

DITS_REQ_END The action is to complete immediately.
DITS_REQ_STAGE The action is to reschedule immediately.
DITS_REQ_WAIT The action is to reschedule on expiry. of a timer.
DITS_REQ_SLEEP The action will be put too sleep. It can be working up by a kick message or a DitsSignal() call.
DITS_REQ_MESSAGE The action will be rescheduled on reception of a message from a subsidiary action.
DITS_REQ_EXIT The action will complete and the task should exit.

Only DITS_REQ_EXIT has any effect when this routine is called from a user interface response routine.

!statusStatusType *Modified status.

Include files

DitsFix.h

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, DitsPutActions(3), DitsInitiateMessage(3), DitsPutDelay(3), DitsSignalByName(3), DitsSignalByAction(3), DitsPutObeyHandler(3), DitsPutKickHandler(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