DitsFmtReason - Converts a reason code and status into a string and outputs an

Function

Converts a reason code and status into a string and outputs an appropriate message into a buffer.

Description

This is a useful debugging routine. The reason code is converted to a string and output to a supplied string.. If the code is a failure code, then the status is also output.

Language

C

Call

(Void) = DitsFmtReason (reason, reasonstat, bufLen, buffer, status)

Parameters

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

>reasonDitsReasonTypeThe reason code
>reasonstatStatusTypeThe status associate with the reason
>bufLenintThe length of the output buffer.
<bufferchar *The output buffer into which to put the string.
!statusStatusType *Modified status.

Include files

DitsFix.h

Prior requirements

none

See Also

The Dits Specification Document, DuiLogEntry(3), DitsGetEntInfo(3), DitsPrintReason(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