Field details for MQEPH

The MQEPH Embedded PCF header structure describes the additional data that is present in a message when that message is a programmable command format (PCF) message. The PCFHeader field defines the PCF parameters that follow this structure and this allows you to follow the PCF message data with other headers.

StrucId (MQCHAR4)

This is the structure identifier of the embedded PCF header structure. It is always an input field. Its value is MQEPH_STRUC_ID.

The value must be:

MQEPH_STRUC_ID: Identifier for the embedded PCF header structure.
For the C programming language, the constant MQEPH_STRUC_ID_ARRAY is also defined. This has the same value as MQEPH_STRUC_ID, but is an array of characters instead of a string.

Version (MQLONG)

The value must be:

MQEPH_VERSION_1: Version number for embedded PCF header structure.

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

MQCFH_VERSION_3: Current version of embedded PCF header structure.

The initial value of this field is MQEPH_VERSION_1.

StrucLength (MQLONG)

This is the amount of data preceding the next header structure. It includes:

The length of the MQEPH header
The length of all PCF parameters following the header
Any blank padding following those parameters

StrucLength must be a multiple of 4.

The fixed length part of the structure is defined by MQEPH_STRUC_LENGTH_FIXED.

The initial value of this field is 68.

Encoding (MQLONG)

This is the numeric encoding of the data that follows the MQEPH structure and the associated PCF parameters; it does not apply to character data in the MQEPH structure itself.

The initial value of this field is 0.

CodedCharSetId (MQLONG)

This is the character set identifier of the data that follows the MQEPH structure and the associated PCF parameters; it does not apply to character data in the MQEPH structure itself.

The initial value of this field is MQCCSI_UNDEFINED.

Format (MQCHAR8)

This is the format name of the data that follows the MQEPH structure and the associated PCF parameters.

The initial value of this field is MQFMT_NONE.

Flags (MQLONG)

The following values are available:

MQEPH_NONE: No flags have been specified. MQEPH_NONE is defined to aid program documentation. It is not intended that this constant be used with any other, but as its value is zero, such use cannot be detected.
MQEPH_CCSID_EMBEDDED: The character set of the parameters containing character data is specified individually within the CodedCharSetId field in each structure. The character set of the StrucId and Format fields is defined by the CodedCharSetId field in the header structure that precedes the MQEPH structure, or by the CodedCharSetId field in the MQMD if the MQEPH is at the start of the message.

The initial value of this field is MQEPH_NONE.

PCFHeader (MQCFH)

This is the programmable command format (PCF) header, defining the PCF parameters that follow the MQEPH structure. This enables you to follow the PCF message data with other headers.

The PCF header is initially defined with the following values:

Table 1. Fields in MQCFH
Field name	Name of constant	Value of constant
`Type`	MQCFT_NONE	`0`
`StrucLength`	MQCFH_STRUC_LENGTH	`36`
`Version`	MQCFH_VERSION_3	`3`
`StrucLength`	None	`0`
`Command`	MQCMD_NONE	`0`
`MsgSeqNumber`	None	`1`
`Control`	MQCFC_LAST	1
`CompCode`	MQCC_OK	`0`
`Reason`	MQRC_NONE	`0`
`ParameterCount`	None	`0`

The application must change the Type from MQCFT_NONE to a valid structure type for the use it is making of the embedded PCF header.