DitsGetEntReason - Get the reason for the current entry of the current action.

Function

Get the reason for the current entry of the current action.

Description

Fetch the reason for this entry from task common. This routine provides an alternative interface to information available from DitsGetReason and DitsGetEntInfo.

Note, this function is implemented as a macro.

Language

Call

(DitsReasonType) = DitsGetEntReason ()

Function value

One of-

`DITS_REA_OBEY`	Obey message received
`DITS_REA_KICK`	Kick message received
`DITS_REA_RESCHED`	Action reschedule by timer expiry
`DITS_REA_TRIGGER`	Action triggered by subsidiary action
`DITS_REA_ASTINT`	Action triggered by signal handler Depreciated, use `DITS_REA_SIGNAL`.
`DITS_REA_SIGNAL`	Action triggered by signal handler.
`DITS_REA_LOAD`	Action triggered by successful load
`DITS_REA_LOADFAILED`	Action triggered by load failure
`DITS_REA_MESREJECTED`	A message was rejected
`DITS_REA_COMPLETE`	Message completed
`DITS_REA_DIED`	Task died
`DITS_REA_PATHFOUND`	Path to a task was found
`DITS_REA_PATHFAILED`	Failed to get a path
`DITS_REA_MESSAGE`	`DITS_MSG_MESSAGE` message received
`DITS_REA_ERROR`	`DITS_ERR_MESSAGE` message received
`DITS_REA_EXIT`	A loaded task has exited.
`DITS_REA_NOTIFY`	A notification request, requested using DitsRequestNotify, returned.
`DITS_REA_BULK_TRANSFERRED`	A notification of bulk data transfer progress.
`DITS_REA_BULK_DONE`	A notifcation that a bulk data transfer is complete.
`DITS_REA_DRAMA2`	A signal triggered by DitsSignalDrama2(), used by the `DRAMA` `V2` implementation.

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.

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