Home

 

Fields

 

Type (MQLONG)

Structure type.

This indicates the content of the message. The following are valid for commands:

MQCFT_COMMAND

Message is a command.

MQCFT_COMMAND_XR

Message is a command to which standard or extended responses may be sent.

MQCFT_RESPONSE

Message is a response to a command.

MQCFT_XR_MSG

Message is an extended response to a command. It contains informational or error details.

MQCFT_XR_ITEM

Message is an extended response to an Inquire command. It contains item data.

MQCFT_XR_SUMMARY

Message is an extended response to a command. It contains summary information.

MQCFT_USER

User-defined PCF message.

StrucLength (MQLONG)

Structure length.

This is the length in bytes of the MQCFH structure. The value must be:

MQCFH_STRUC_LENGTH

Length of command format header structure.

V(MQLONG)

Structure version number.

The value must be:

MQCFH_VERSION_3

Vnumber for command format header structure.

The following constant specifies the version number of the current version:

MQCFH_CURRENT_VERSION

Current version of command format header structure.

Command (MQLONG)

Command identifier.

For a command message, this identifies the function to be performed. For a response message, it identifies the command to which this is the reply. See the description of each command for the value of this field.

MsgSeqNumber (MQLONG)

Message sequence number.

This is the sequence number of the message within a set of related messages. For a command, this field must have the value one (because a command is always contained within a single message). For a response, the field has the value one for the first (or only) response to a command, and increases by one for each successive response to that command.

The last (or only) message in a set has the MQCFC_LAST flag set in the Control field. T

Control (MQLONG)

Control options.

The following are valid:

MQCFC_LAST

Last message in the set.

For a command, this value must always be set.

MQCFC_NOT_LAST

Not the last message in the set.

CompCode (MQLONG)

Completion code.

This field is meaningful only for a response; its value is not significant for a command. The following are possible:

MQCC_OK

Command completed successfully.

MQCC_WARNING

Command completed with warning.

MQCC_FAILED

Command failed.

MQCC_UNKNOWN

Whether command succeeded is not known.

Reason (MQLONG)

Reason code qualifying completion code.

This field is meaningful only for a response; its value is not significant for a command.

The possible reason codes that could be returned in response to a command are listed in Definitions of the Programmable Command Formats, and in the description of each command.

ParameterCount (MQLONG)

Count of parameter structures.

This is the number of parameter structures (MQCFBF, MQCFBS, MQCFIF, MQCFIL, MQCFIN, MQCFSL, MQCFSF, and MQCFST) that follow the MQCFH structure. The value of this field is zero or greater.

 

Parent topic:

MQCFH - PCF header

pc14610_

 

Home