MQEPH - Embedded PCF header

Use this page to view the structure of an MQEPH embedded PCF header and the declarations for the following programming languages: C, COBOL, PL/I, RPG/ILE, S/390 assembler, and Visual Basic

The MQEPH structure describes the additional data that is present in a message when that message is a programmable command format (PCF) message. Following the links to the declarations is a description of the fields making up the MQEPH structure:

The additional data consists of the MQEPH structure followed by an array of PCF parameter structures. To include the MQEPH structure in a message, the Format parameter in the message descriptor is set to MQFMT_EMBEDDED.

    StrucId

    Description: Structure identifier.
    Data type: MQCHAR4.
    Value:

      MQEPH_STRUC_ID
      Identifier for distribution header structure.

    Version

    Description: Structure version number.
    Data type: MQLONG.
    Value:

      MQEPH_VERSION_1
      Version number for embedded PCF header structure.

    StrucLength

    Description: Structure length. This is the length in bytes of the MQEPH structure and is set to the amount of data preceding the next header structure.
    Data type: MQLONG.

    Encoding

    Description: Numeric encoding. This specifies the numeric encoding of the data that follows the last PCF parameter structure.
    Data type: MQLONG.

    CodedCharSetId

    Description: Coded character set identifier. This specifies the coded character set identifier of the data that follows the last PCF parameter structure.
    Data type: MQLONG.

    Format

    Description: Format. This specifies the format name of the data that follows the last PCF parameter structure.
    Data type: MQCHAR8.

    Flags

    Description: Flags. This is a reserved field.
    Data type: MQLONG.
    Value:

      MQEPH_NONE
      No flags have been specified.

      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.

    PCFHeader

    Description: Command format header.
    Data type: MQCFH.


C language declaration



struct tagMQEPH  {
  MQCHAR4 StrucId;         /* Structure identifier */
  MQLONG  Version;         /* Structure version number */
  MQLONG  StrucLength      /* Structure length */
  MQLONG  Encoding;        /* Numeric encoding */
  MQLONG  CodedCharSetId;  /* Coded character set identifier */
  MQCHAR8 Format;          /* Data format */
  MQLONG  Flags;           /* Flags */
  MQCFH   PCFHeader;       /* PCF header */
 } MQEPH;


COBOL language declaration

**   MQEPH structure
  10 MQEPH.
**    Structure identifier
   15 MQEPH-STRUCID        PIC X(4).
**    Structure version number
   15 MQEPH-VERSION        PIC S9(9) BINARY.
**    Structure length
   15 MQEPH-STRUCLENGTH    PIC S9(9) BINARY.
**    Numeric encoding
   15 MQEPH-ENCODING       PIC S9(9) BINARY.
**    Coded characeter set identifier
   15 MQEPH-CODEDCHARSETID PIC S9(9) BINARY.
**    Data format
   15 MQEPH-FORMAT         PIC X(8).
**    Flags
   15 MQEPH-FLAGS          PIC S9(9) BINARY.
**    PCF header
   15 MQEPH-PCFHEADER.
**    Structure type
    20 MQEPH-PCFHEADER-TYPE            PIC S9(9) BINARY.
**    Structure length
    20 MQEPH-PCFHEADER-STRUCLENGTH     PIC S9(9) BINARY.
**    Structure version number
    20 MQEPH-PCFHEADER-VERSION         PIC S9(9) BINARY.
**    Command identifier
    20 MQEPH-PCFHEADER-COMMAND         PIC S9(9) BINARY.
**    Message sequence number
    20 MQEPH-PCFHEADER-MSGSEQNUMBER    PIC S9(9) BINARY.
**    Control options
    20 MQEPH-PCFHEADER-CONTROL         PIC S9(9) BINARY.
**    Completion code
    20 MQEPH-PCFHEADER-COMPCODE        PIC S9(9) BINARY.
**    Reason code qualifying completion code
    20 MQEPH-PCFHEADER-REASON          PIC S9(9) BINARY.
**    Count of parameter structures
    20 MQEPH-PCFHEADER-PARAMETERCOUNT  PIC S9(9) BINARY.


PL/I language declaration ( z/OS and Windows )

dcl
 1 MQEPH based,
  3 StrucId         char(4),       /* Structure identifier */
  3 Version         fixed bin(31), /* Structure version number */
  3 StrucLength     fixed bin(31), /* Structure length */
  3 Encoding        fixed bin(31), /* Numeric encoding */
  3 CodedCharSetId  fixed bin(31), /* Coded character set identifier */
  3 Format          char(8),       /* Data format */
  3 Flags           fixed bin(31), /* Flags */
  3 PCFHeader,                     /* PCF header */
   5 Type           fixed bin(31), /* Structure type */
   5 StrucLength    fixed bin(31), /* Structure length */
   5 Version        fixed bin(31), /* Structure version number */
   5 Command        fixed bin(31), /* Command identifier */
   5 MsgSeqNumber   fixed bin(31), /* Message sequence number */
   5 Control        fixed bin(31), /* Control options */
   5 CompCode       fixed bin(31), /* Completion code */
   5 Reason         fixed bin(31), /* Reason code qualifying completion
                                     code */
   5 ParameterCount fixed bin(31); /* Count of parameter structures */


RPG language declaration ( IBM i only)

D*..1....:....2....:....3....:....4....:....5....:....6....:....7..
D* MQEPH Structure
D*
D* Structure identifier
D  EPSID                  1      4    INZ('EPH ')
D* Structure version number
D  EPVER                  5      8I 0 INZ(1)
D* Structure length
D  EPLEN                  9     12I 0 INZ(68)
D* Numeric encoding
D  EPENC                 13     16I 0 INZ(0)
D* Coded character set identifier
D  EPCSI                 17     20I 0 INZ(0)
D* Format name
D  EPFMT                 21     28I 0 INZ('        ')
D* Flags
D  EPFLG                 29     32I 0 INZ(0)
D* Programmable Command Format Header
D* 
D* Structure type
D  EP1TYPE               33     36I 0 INZ(0) 
D* Structure length
D  EP1LEN                37     40I 0 INZ(36) 
D* Structure version number
D  EP1VER                41     44I 0 INZ(3) 
D* Command identifier
D  EP1CMD                45     48I 0 INZ(0) 
D* Message sequence number
D  EP1SEQ                49     52I 0 INZ(1) 
D* Control options
D  EP1CTL                53     56I 0 INZ(1) 
D* Completion code
D  EP1CMP                57     60I 0 INZ(0) 
D* Reason code qualifying completion code
D  EP1REA                61     64I 0 INZ(0) 
D* Count of parameter structures
D  EP1CNT                65     68I 0 INZ(0)


S/390 assembler-language declaration ( z/OS only)

MQEPH                          DSECT
MQEPH_STRUCID                  DS   CL4      Structure identifier
MQEPH_VERSION                  DS   F        Structure version number
MQEPH_STRUCLENGTH              DS   F        Structure length
MQEPH_ENCODING                 DS   F        Numeric encoding
MQEPH_CODEDCHARSETID           DS   F        Coded character set identifier
MQEPH_FORMAT                   DS   CL8      Data format
MQEPH_FLAGS                    DS   F        Flags
MQEPH_PCFHEADER                DS   0F       Force fullword alignment
MQEPH_PCFHEADER_TYPE           DS   F        Structure type
MQEPH_PCFHEADER_STRUCLENGTH    DS   F        Structure length
MQEPH_PCFHEADER_VERSION        DS   F        Structure version number
MQEPH_PCFHEADER_COMMAND        DS   F        Command identifier
MQEPH_PCFHEADER_MSGSEQNUMBER   DS   F        Message sequence number
MQEPH_PCFHEADER_CONTROL        DS   F        Control options
MQEPH_PCFHEADER_COMPCODE       DS   F        Completion code
MQEPH_PCFHEADER_REASON         DS   F        Reason code qualifying completion code
MQEPH_PCFHEADER_PARAMETERCOUNT DS   F        Count of parameter structures
MQEPH_PCFHEADER_LENGTH         EQU  *-MQEPH_PCFHEADER
                               ORG  MQEPH_PCFHEADER
MQEPH_PCFHEADER_AREA           DS   CL(MQEPH_PCFHEADER_LENGTH)
*
MQEPH_LENGTH                   EQU  *-MQEPH
                               ORG  MQEPH
MQEPH_AREA                     DS   CL(MQEPH_LENGTH)


Visual Basic language declaration ( Windows only)

Type MQEPH
  StrucId As String*4     'Structure identifier
  Version As Long         'Structure version number
  StrucLength As Long     'Structure length
  Encoding As Long        'Numeric encoding
  CodedCharSetId As Long  'Coded characetr set identifier
  Format As String*8      'Format name
  Flags As Long           'Flags
  Reason As Long          'Reason code qualifying completion code
  PCFHeader As MQCFH      'PCF header
End Type
Parent topic: Structure data types