Fields for MQCBC

Alphabetic list of fields for the MQCBC structure.

The MQCBC structure contains the following fields; the fields are described in alphabetical order:

  • BufferLength (MQLONG)
    This field is the length in bytes of the message buffer that has been passed to this function.
  • CallbackArea (MQPTR)
    This field is available for the callback function to use.
  • CallType (MQLONG)
    Field containing information about why this function has been called; the following values are defined.
  • CompCode (MQLONG)
    This field is the completion code. It indicates whether there were any problems consuming the message.
  • ConnectionArea (MQPTR)
    This field is available for the callback function to use.
  • DataLength (MQLONG)
    This is the length in bytes of the application data in the message. If the value is zero, it means that the message contains no application data.
  • Flags (MQLONG)
    Flags containing information about this consumer.
  • Hobj (MQHOBJ)
    This is the object handle for calls to the message consumer.
  • Reason (MQLONG)
    This is the reason code qualifying the CompCode.
  • State (MQLONG)
    An indication as to the state of the current consumer. This field is of most value to an application when a nonzero reason code is passed to the consumer function.
  • StrucId (MQCHAR4)
    The value in this field is the structure identifier.
  • Version (MQLONG)
    The value in this field is the structure version number.
  • ReconnectDelay (MQLONG)
    ReconnectDelay indicates how long the queue manager will wait before trying to reconnect. The field can be modified by an event handler to change the delay or stop reconnection altogether.

Parent topic: MQCBC - Callback context