MQCFH (Event header)


The MQCFH structure is the header structure used for event messages and for PCF messages. When the structure is used for event messages, the message descriptor Format field is MQFMT_EVENT. The datatype of the following parameters (MQLONG) is described in the WebSphere MQ Application Programming Reference manual.

For an event, the MQCFH structure contains these values:

Type

Description: Structure type that identifies the content of the message.
Datatype: MQLONG.
Value:

MQCFT_EVENT
Message is reporting an event.

StrucLength

Description: Structure length.
Datatype: MQLONG.
Value:

MQCFH_STRUC_LENGTH
Length in bytes of MQCFH structure.

Version

Description: Structure version number.
Datatype: MQLONG.
Values:

MQCFH_VERSION_1
Version-1 in all events except configuration events.

MQCFH_VERSION_2
Version-2 for configuration events.

Command

Description: Command identifier. This identifies the event category.
Datatype: MQLONG.
Values:

MQCMD_Q_MGR_EVENT
Queue manager event.

MQCMD_PERFM_EVENT
Performance event.

MQCMD_CHANNEL_EVENT
Channel event.

MQCMD_CONFIG_EVENT
Configuration event.

MsgSeqNumber

Description: Message sequence number. This is the sequence number of the message within a group of related messages.
Datatype: MQLONG.
Values:

1
For change object configuration events with attribute values before the changes, and for all other types of events.

2
For change object configuration events with the attribute values after the changes

Control

Description: Control options.
Datatype: MQLONG.
Values:

MQCFC_LAST
For change object configuration events with attribute values after the changes, and for all other types of events.

MQCFC_NOT_LAST
For Change Object configurations events only, with the attribute values from before the changes.

CompCode

Description: Completion code.
Datatype: MQLONG.
Values:

MQCC_OK
Event reporting OK condition.

MQCC_WARNING
Event reporting warning condition. All events have this completion code, unless otherwise specified.

Reason

Description: Reason code qualifying completion code.
Datatype: MQLONG.
Values: MQRC_* Dependent on the event being reported.

Note:
Events with the same reason code are further identified by the ReasonQualifier parameter in the event data.

ParameterCount

Description: Count of parameter structures. Number of parameter structures (MQCFIN, MQCFST, MQCFSL and MQCFBS) that follow the MQCFH structure.
Datatype: MQLONG.
Values: 0 or greater.

 

C language declaration (MQCFH)

typedef struct tagMQCFH {
  MQLONG  Type;            /* Structure type */
  MQLONG  StrucLength;     /* Structure length */
  MQLONG  Version;         /* Structure version number */
  MQLONG  Command;         /* Command identifier */
  MQLONG  MsgSeqNumber;    /* Message sequence number */
  MQLONG  Control;         /* Control options */
  MQLONG  CompCode;        /* Completion code */
  MQLONG  Reason;          /* Reason code qualifying completion code */
  MQLONG  ParameterCount;  /* Count of parameter structures */
 } MQCFH;

 

COBOL language declaration (MQCFH)

**   MQCFH structure
  10 MQCFH.
**    Structure type
   15 MQCFH-TYPE           PIC S9(9) BINARY.
**    Structure length
   15 MQCFH-STRUCLENGTH    PIC S9(9) BINARY.
**    Structure version number
   15 MQCFH-VERSION        PIC S9(9) BINARY.
**    Command identifier
   15 MQCFH-COMMAND        PIC S9(9) BINARY.
**    Message sequence number
   15 MQCFH-MSGSEQNUMBER   PIC S9(9) BINARY.
**    Control options
   15 MQCFH-CONTROL        PIC S9(9) BINARY.
**    Completion code
   15 MQCFH-COMPCODE       PIC S9(9) BINARY.
**    Reason code qualifying completion code
   15 MQCFH-REASON         PIC S9(9) BINARY.
**    Count of parameter structures
   15 MQCFH-PARAMETERCOUNT PIC S9(9) BINARY.

 

PL/I language declaration (MQCFH)

dcl
 1 MQCFH based,
  3 Type           fixed bin(31), /* Structure type */
  3 StrucLength    fixed bin(31), /* Structure length */
  3 Version        fixed bin(31), /* Structure version number */
  3 Command        fixed bin(31), /* Command identifier */
  3 MsgSeqNumber   fixed bin(31), /* Message sequence number */
  3 Control        fixed bin(31), /* Control options */
  3 CompCode       fixed bin(31), /* Completion code */
  3 Reason         fixed bin(31), /* Reason code qualifying completion
                                     code */
  3 ParameterCount fixed bin(31); /* Count of parameter structures */

 

RPG/ILE declaration (MQCFH) (OS/400 only)

     D*..1....:....2....:....3....:....4....:....5....:....6....:....7..
     D* MQCFH Structure
     D*
     D* Structure type
     D  FHTYP                  1      4I 0
     D* Structure length
     D  FHLEN                  5      8I 0
     D* Structure version number
     D  FHVER                  9     12I 0
     D* Command identifier
     D  FHCMD                 13     16I 0
     D* Message sequence number
     D  FHSEQ                 17     20I 0
     D* Control options
     D  FHCTL                 21     24I 0
     D* Completion code
     D  FHCMP                 25     28I 0
     D* Reason code qualifying completion code
     D  FHREA                 29     32I 0
     D* Count of parameter structures
     D  FHCNT                 33     36I 0

 

System/390(R) assembler-language declaration (MQCFH) (z/OS only)

MQCFH                          DSECT
MQCFH_TYPE                     DS   F        Structure type
MQCFH_STRUCLENGTH              DS   F        Structure length
MQCFH_VERSION                  DS   F        Structure version number
MQCFH_COMMAND                  DS   F        Command identifier
MQCFH_MSGSEQNUMBER             DS   F        Message sequence number
MQCFH_CONTROL                  DS   F        Control options
MQCFH_COMPCODE                 DS   F        Completion code
MQCFH_REASON                   DS   F        Reason code qualifying
*                                            completion code
MQCFH_PARAMETERCOUNT           DS   F        Count of parameter
*                                            structures
MQCFH_LENGTH                   EQU  *-MQCFH  Length of structure
                               ORG  MQCFH
MQCFH_AREA                     DS   CL(MQCFH_LENGTH)

 

Visual Basic(R) language declaration (MQCFH) (Windows platforms only)

Type MQCFH
  Type As Long            'Structure type
  StrucLength As Long     'Structure length
  Version As Long         'Structure version number
  Command As Long         'Command identifier
  MsgSeqNumber As Long    'Message sequence number
  Control As Long         'Control options
  CompCode As Long        'Completion code
  Reason As Long          'Reason code qualifying completion code
  ParameterCount As Long  'Count of parameter structures
End Type
 
Global MQCFH_DEFAULT As MQCFH

 

WebSphere is a trademark of the IBM Corporation in the United States, other countries, or both.

 

IBM is a trademark of the IBM Corporation in the United States, other countries, or both.