[UNIX, Linux, Windows, IBM i]

MQCMD_ESCAPE (Escape) Response on Multiplatforms

The response to the Escape (MQCMD_ESCAPE) PCF command consists of the response header followed by two parameter structures, one containing the escape type, and the other containing the text response. More than one such message might be issued, depending upon the command contained in the Escape request.

The Command field in the response header MQCFH contains the MQCMD_* command identifier of the text command contained in the EscapeText parameter in the original Escape command. For example, if EscapeText in the original Escape command specified PING QMGR, Command in the response has the value MQCMD_PING_Q_MGR.

If it is possible to determine the outcome of the command, the CompCode in the response header identifies whether the command was successful. The success or otherwise can therefore be determined without the recipient of the response having to parse the text of the response.

If it is not possible to determine the outcome of the command, CompCode in the response header has the value MQCC_UNKNOWN, and Reason is MQRC_NONE.

Parameters

EscapeType (MQCFIN)
Escape type (parameter identifier: MQIACF_ESCAPE_TYPE).
The only value supported is:
MQET_MQSC
IBM® MQ command.
EscapeText (MQCFST)
Escape text (parameter identifier: MQCACF_ESCAPE_TEXT).

A string holding the response to the original command.