PMDF Programmer's Reference Manual
PMDF-PRM-6.0

Previous | Contents

PMDF_get_error_text

Obtain any error message associated with a PMDF__ error status code.

VMS FORMAT

status = PMDF_get_error_text

(nq_context, text, text_len)

argument information
Argument Data type Access Mechanism
nq_context context pointer read/write reference
text descriptor read/write reference
text_len unsigned word write reference

C FORMAT

status = PMDFgetErrorText

(nq_context, text, text_len)

argument information 
int PMDFgetErrorText (nq_context, text, text_len) 
         PMDF_nq **nq_context; 
         char     *text; 
         int      *text_len;

ARGUMENTS

text

String to receive a description associated with an error message. Must be at least ALFA_SIZE bytes in length. (ALFA_SIZE+1 bytes for PMDFgetErrorText.)

text_len

Length in bytes of the returned description. Callers using PMDFgetErrorText must, on input, supply the maximum length in bytes of text.

DESCRIPTION

In some cases, after a PMDF__ error has been returned, additional information about the error may be obtained by calling PMDF_get_error_text. This additional information is returned as a text string and is suitable for writing to a log file. The applicable cases are The above cases do not include errors associated with bad call arguments; that is, do not apply when the error resulted from passing a bad parameter to the routine which returned the error.
Return Values
PMDF__OK Normal, successful completion.
PMDF__FATERRLIB Call to LIB$SCOPY_R_DX failed owing to a fatal internal error in the OpenVMS Run Time Library. Error text not returned.
PMDF__INSVIRMEM Insufficient virtual memory: call to LIB$GET_VM made by LIB$SCOPY_R_DX has failed. Error text not returned.
PMDF__INVSTRDES Invalid string descriptor for text: descriptor has an invalid value in its DSC$B_CLASS field. Error text not returned.
PMDF__STRTRU Supplied string was too long; value truncated to fit.

Previous | Next | Contents