MQBMHO - Buffer to message handle options

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 (MQENC_NATIVE).

Fields

Note: In the following table, the fields are grouped by usage rather than alphabetically.
Table 1. Fields in MQBMHO
Field name and description Name of constant Initial value (if any) of constant
StrucId (structure identifier) MQBMHO_STRUC_ID 'BMHO'
Version (structure version number) MQBMHO_VERSION_1 1
Options (options controlling the action of MQBMHO) MQBMHO_NONE 0
Notes:
  1. In the C programming language, the macro variable MQBMHO_DEFAULT contains the values that are listed in the table. Use it in the following way to provide initial values for the fields in the structure: 
    MQBMHO MyBMHO = {MQBMHO_DEFAULT};

Language declarations

C declaration for MQBMHO

typedef struct tagMQBMHO MQBMHO;
struct tagMQBMHO {
  MQCHAR4  StrucId;        /* Structure identifier */
  MQLONG   Version;        /* Structure version number */
  MQLONG   Options;        /* Options that control the action of
                              MQBUFMH */ 
};

COBOL declaration for MQBMHO

**   MQBMHO structure
  10 MQBMHO.
**    Structure identifier
   15 MQBMHO-STRUCID                PIC X(4).
**    Structure version number
   15 MQBMHO-VERSION                PIC S9(9) BINARY.
**    Options that control the action of MQBUFMH
   15 MQBMHO-OPTIONS                PIC S9(9) BINARY.

PL/I declaration for MQBMHO

Dcl
 1 MQBMHO based,
  3 StrucId        char(4),       /* Structure identifier */
  3 Version        fixed bin(31), /* Structure version number */
  3 Options        fixed bin(31), /* Options that control the action
                                     of MQBUFMH */

High Level Assembler declaration for MQBMHO

MQBMHO                      DSECT
MQBMHO_STRUCID              DS   CL4  Structure identifier
MQBMHO_VERSION              DS   F    Structure version number
MQBMHO_OPTIONS              DS   F    Options that control the
*                                     action of MQBUFMH
MQBMHO_LENGTH               EQU  *-MQBMHO
MQBMHO_AREA                 DS   CL(MQBMHO_LENGTH)