LU 6.2 API Application Programmer's Reference Guide (30294-90008)

Chapter 5 89
Intrinsic Descriptions
MCErrMsg
MCErrMsg
Provides the message corresponding to a status info value that was
returned in a previous intrinsic call.
Syntax
I32V CA I16 I32
MCErrMsg(OldStatus, MessageBuffer , MessageLength , Status );
Parameters
OldStatus
Required; 32-bit signed integer by value; input. The
status info value for which a corresponding message is
desired. This is a value that was returned in the
Status parameter of a previous intrinsic call.
MCErrMsg returns the message that corresponds to the
value in this parameter.
MessageBuffer
Required; character array; output. A 256-byte
character array in which the error message is returned.
MessageLength
Required; 16-bit signed integer; output. An integer
representing the length, in bytes, of the message
returned in
MessageBuffer .
Status
Required; 32-bit signed integer; output. This status
info value contains information about the execution of
the MCErrMsg intrinsic. See the “Status Parameter”
section, earlier in this chapter, for more information.
Description
The MCErrMsg intrinsic gives you the message that corresponds to the
status info value you received in a previous intrinsic call. The MCErrMsg
intrinsic obtains only local information; it will not return messages
generated on the remote side.
MCErrMsg can be called from any conversation state, and it does not
change the state of the conversation.