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

PASCAL

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

status = PMDFgetErrorText

(nq_context, text, text_len)

argument information

int PMDFgetErrorText(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+1 bytes in length.

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 can be obtained by calling PMDFgetErrorText . This additional information is returned as a text string and is suitable for writing to a log file. The applicable cases are

• after an error from PMDFaddRecipient ,
• after an error from PMDFenqueueMessage , or
• after an error from PMDFstartMessageEnvelope .

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.