Event message MQCFH (PCF header)

The message data in event messages is in programmable command format (PCF), as used in PCF command inquiries and responses. The message data consists of two parts: the event header and the event data.

The MQCFH header specifies the following information:

  • The category of event: whether the event is a queue manager, performance, channel, configuration, command, or logger event.
  • A reason code specifying the cause of the event. For events caused by MQI calls, this reason code is the same as the reason code for the MQI call.

Reason codes have names that begin with the characters MQRC_. For example, the reason code MQRC_PUT_INHIBITED is generated when an application attempts to put a message on a queue that is not enabled for puts.

For an event, the MQCFH structure contains the following values:

    Type

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

      MQCFT_EVENT
      Message is reporting an event.

    StrucLength

    Description: Structure length.
    Data type: MQLONG.
    Value:

      MQCFH_STRUC_LENGTH
      Length in bytes of MQCFH structure.

    Version

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

    Command

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

      MQCMD_Q_MGR_EVENT
      Queue manager event.

      MQCMD_PERFM_EVENT
      Performance event.

      MQCMD_CHANNEL_EVENT
      Channel event.

      MQCMD_CONFIG_EVENT
      Configuration event.

      MQCMD_COMMAND_EVENT
      Command event.

      MQCMD_LOGGER_EVENT
      Logger event.

    MsgSeqNumber

    Description: Message sequence number. This is the sequence number of the message within a group of related messages.
    Data type: 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.
    Data type: 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.
    Data type: 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.
    Data type: 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. This is the number of parameter structures that follow the MQCFH structure. A group structure (MQCFGR), and its included parameter structures, are counted as one structure only.
    Data type: MQLONG.
    Values: 0 or greater.

Parent topic: Event message reference