MQBMHO (Buffer to message handle options) on IBM i

Structure defining the buffer to message handle options.

Overview

Purpose: The MQBMHO structure allows applications to specify options that control how message handles are produced from buffers. The structure is an input parameter on the MQBUFMH call.

Character set and encoding: Data in MQBMHO must be in the character set of the application and encoding of the application (ENNAT).

• Fields
• Initial values
• RPG declaration

Fields

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

BMSID (10-digit signed integer)

Buffer to message handle structure - StrucId field.

This is the structure identifier. The value must be:

BMSIDV

Identifier for buffer to message handle structure.

This is always an input field. The initial value of this field is BMSIDV.

BMVER (10-digit signed integer)

Buffer to message handle structure - Version field.

This is the structure version number. The value must be:

BMVER1

Version number for buffer to message handle structure.

The following constant specifies the version number of the current version:

BMVERVC

Current version of buffer to message handle structure.

This is always an input field. The initial value of this field is BMVER1.

BMOPT (10-digit signed integer)

Buffer to message handle structure - Options field.

The value can be:

BMDLPR

Properties that are added to the message handle are deleted from the buffer. If the call fails no properties are deleted.

Default options: If we do not need the option described, use the following option:

BMNONE

No options specified.

This is always an input field. The initial value of this field is BMDLPR.

Initial values

RPG declaration

     D* MQBMHO Structure
     D*
     D*
     D* Structure identifier
     D  BMSID                  1      4    INZ('BMHO')
     D*
     D* Structure version number
     D  BMVER                  5      8I 0 INZ(1)
     D*
     D* Options that control the action of MQBUFMH
     D  BMOPT                  9     12I 0 INZ(1)