FM* values" /> MDFMT (8-byte character string)

 

MDFMT (8-byte character string)

Format name of message data.

This is a name that the sender of the message may use to indicate to the receiver the nature of the data in the message. Any characters that are in the queue manager's character set may be specified for the name, but it is recommended that the name be restricted to the following:

If other characters are used, it may not be possible to translate the name between the character sets of the sending and receiving queue managers.

The name should be padded with blanks to the length of the field, or a null character used to terminate the name before the end of the field; the null and any subsequent characters are treated as blanks. Do not specify a name with leading or embedded blanks. For the MQGET call, the queue manager returns the name padded with blanks to the length of the field.

The queue manager does not check that the name complies with the recommendations described above.

Names beginning "MQ" in upper, lower, and mixed case have meanings that are defined by the queue manager; you should not use names beginning with these letters for your own formats. The queue manager built-in formats are:

FMNONE

No format name.

The nature of the data is undefined. This means that the data cannot be converted when the message is retrieved from a queue using the GMCONV option.

If GMCONV is specified on the MQGET call, and the character set or encoding of data in the message differs from that specified in the MSGDSC parameter, the message is returned with the following completion and reason codes (assuming no other errors):

  • Completion code CCWARN and reason code RC2110 if the FMNONE data is at the beginning of the message.

  • Completion code CCOK and reason code RCNONE if the FMNONE data is at the end of the message (that is, preceded by one or more MQ header structures). The MQ header structures are converted to the requested character set and encoding in this case.

FMADMN

Command server request/reply message.

The message is a command-server request or reply message in programmable command format (PCF). Messages of this format can be converted if the GMCONV option is specified on the MQGET call. Refer to the WebSphere MQ Programmable Command Formats and Administration Interface book for more information about using programmable command format messages.

FMCICS

CICS information header.

The message data begins with the CICS information header MQCIH, which is followed by the application data. The format name of the application data is given by the CIFMT field in the MQCIH structure.

FMCMD1

Type 1 command reply message.

The message is an MQSC command-server reply message containing the object count, completion code, and reason code. Messages of this format can be converted if the GMCONV option is specified on the MQGET call.

FMCMD2

Type 2 command reply message.

The message is an MQSC command-server reply message containing information about the object(s) requested. Messages of this format can be converted if the GMCONV option is specified on the MQGET call.

FMDLH

Dead-letter header.

The message data begins with the dead-letter header MQDLH. The data from the original message immediately follows the MQDLH structure. The format name of the original message data is given by the DLFMT field in the MQDLH structure; see MQDLH - Dead-letter header for details of this structure. Messages of this format can be converted if the GMCONV option is specified on the MQGET call.

COA and COD reports are not generated for messages which have a MDFMT of FMDLH.

FMDH

Distribution-list header.

The message data begins with the distribution-list header MQDH; this includes the arrays of MQOR and MQPMR records. The distribution-list header may be followed by additional data. The format of the additional data (if any) is given by the DHFMT field in the MQDH structure; see MQDH - Distribution header for details of this structure. Messages with format FMDH can be converted if the GMCONV option is specified on the MQGET call.

FMEVNT

Event message.

The message is an MQ event message that reports an event that occurred. Event messages have the same structure as programmable commands; Refer to the WebSphere MQ Programmable Command Formats and Administration Interface book for more information about this structure, and to the Monitoring WebSphere MQ book for information about events.

Version-1 event messages can be converted if the GMCONV option is specified on the MQGET call.

FMIMS

IMS information header.

The message data begins with the IMS information header MQIIH, which is followed by the application data. The format name of the application data is given by the IIFMT field in the MQIIH structure. Messages of this format can be converted if the GMCONV option is specified on the MQGET call.

FMIMVS

IMS variable string.

The message is an IMS variable string, which is a string of the form

llzzccc, where:

ll

is a 2-byte length field specifying the total length of the IMS variable string item. This length is equal to the length of

ll (2 bytes), plus the length of

zz (2 bytes), plus the length of the character string itself.

ll is a 2-byte binary integer in the encoding specified by the MDENC field.

zz

is a 2-byte field containing flags that are significant to IMS.

zz is a byte string consisting of two 1-byte bit string fields, and is transmitted without change from sender to receiver (that is,

zz is not subject to any conversion).

ccc

is a variable-length character string containing

ll-4 characters. ccc is in the character set specified by the MDCSI field.

Messages of this format can be converted if the GMCONV option is specified on the MQGET call.

FMMDE

Message-descriptor extension.

The message data begins with the message-descriptor extension MQMDE, and is optionally followed by other data (usually the application message data). The format name, character set, and encoding of the data which follows the MQMDE is given by the MEFMT, MECSI, and MEENC fields in the MQMDE. See MQMDE - Message descriptor extension for details of this structure. Messages of this format can be converted if the GMCONV option is specified on the MQGET call.

FMPCF

User-defined message in programmable command format (PCF).

The message is a user-defined message that conforms to the structure of a programmable command format (PCF) message. Messages of this format can be converted if the GMCONV option is specified on the MQGET call. Refer to the WebSphere MQ Programmable Command Formats and Administration Interface book for more information about using programmable command format messages.

FMRMH

Reference message header.

The message data begins with the reference message header MQRMH, and is optionally followed by other data. The format name, character set, and encoding of the data is given by the RMFMT, RMCSI, and RMENC fields in the MQRMH. See MQRMH - Reference message header for details of this structure. Messages of this format can be converted if the GMCONV option is specified on the MQGET call.

FMRFH

Rules and formatting header.

The message data begins with the rules and formatting header MQRFH, and is optionally followed by other data. The format name, character set, and encoding of the data (if any) is given by the RFFMT, RFCSI, and RFENC fields in the MQRFH. Messages of this format can be converted if the GMCONV option is specified on the MQGET call.

FMRFH2

Rules and formatting header version 2.

The message data begins with the version-2 rules and formatting header MQRFH2, and is optionally followed by other data. The format name, character set, and encoding of the optional data (if any) is given by the RF2FMT, RF2CSI, and RF2ENC fields in the MQRFH2. Messages of this format can be converted if the GMCONV option is specified on the MQGET call.

FMSTR

Message consisting entirely of characters.

The application message data can be either an SBCS string (single-byte character set), or a DBCS string (double-byte character set). Messages of this format can be converted if the GMCONV option is specified on the MQGET call.

FMTM

Trigger message.

The message is a trigger message, described by the MQTM structure; see MQTM - Trigger message for details of this structure. Messages of this format can be converted if the GMCONV option is specified on the MQGET call.

FMWIH

Work information header.

The message data begins with the work information header MQWIH, which is followed by the application data. The format name of the application data is given by the WIFMT field in the MQWIH structure.

FMXQH

Transmission queue header.

The message data begins with the transmission queue header MQXQH. The data from the original message immediately follows the MQXQH structure. The format name of the original message data is given by the MDFMT field in the MQMD structure which is part of the transmission queue header MQXQH. See MQXQH - Transmission-queue header for details of this structure.

COA and COD reports are not generated for messages which have a MDFMT of FMXQH.

This is an output field for the MQGET call, and an input field for the MQPUT and MQPUT1 calls. The length of this field is given by LNFMT. The initial value of this field is FMNONE.