Escape on Multiplatforms

The Escape (MQCMD_ESCAPE) command conveys any IBM MQ command (MQSC) to a remote queue manager.

Use the Escape command when the queue manager (or application) sending the command does not support the particular IBM MQ command, and so does not recognize it and cannot construct the required PCF command.

The Escape command can also be used to send a command for which no Programmable Command Format has been defined.

The only type of command that can be carried is one that is identified as an MQSC, that is recognized at the receiving queue manager.

Required 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 to hold a command. The length of the string is limited only by the size of the message.

Error codes

This command might return the following error code in the response format header, in addition to the values shown in Error codes applicable to all commands.

Reason (MQLONG)

The value can be any of the following values:

MQRCCF_ESCAPE_TYPE_ERROR

Escape type not valid.

Parent topic: Definitions of the Programmable Command Formats