DsInqErrorMessage(3D)

NAME
DsInqErrorMessage - Return an error message

SYNOPSIS
C:
DtReadStatus DsInqErrorMessage(errornumber, bufbytes,
		buf, severity)
DtInt errornumber, bufbytes;
char buf[];
DtErrorStatus *severity;

FORTRAN:
INTEGER*4 DSQEM(ERRNUM, BUFSIZ, BUF, SEVERT)
INTEGER*4 ERRNUM, BUFSIZ
CHARACTER*BUFSIZ BUF
INTEGER*4 SEVERT

DESCRIPTION
DsInqErrorMessage copies an error message into user-supplied space. The parameter errornumber specifies the error message. The parameter bufbytes specifies the size of the user-supplied space. The parameter buf specifies the address of that space.

The parameter severity is a returned error status specifying the severity associated with the error. The severity describes the type of error and is one of the following values:

DcErrorMinor <DCEMNR>
    Program will proceed with only minor effects likely.

DcErrorSevere <DCESEV>
    Program can proceed but results are unpredictable.

DcErrorFatal <DCEFAT>
    Program cannot proceed. If the default error handler is being used, it will exit the program. If a user-specified error handler is being used, it should try to exit gracefully.

DsInqErrorMessage is intended for use by user-supplied error handling routines installed with DsSetErrorVars <DSSEV>. Possible return values are:

DcReadOk <DCROK>
    The error message was successfully read and written into the user's space.

DcReadTrunc <DCRTRN>
    The error message was too large to fit in the given space and was truncated.

DcReadUnsuc <DCRFAL>
    The given error was not found.

SEE ALSO
DsSetErrorVars(3D), DsInqErrorVars(3D)