MQMHBO - Message handle to buffer options

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

Character set and encoding

Data in MQMHBO 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 MQMHBO
Field name and description Name of constant Initial value (if any) of constant
StrucId (structure identifier) MQMHBO_STRUC_ID 'MHBO'
Version (structure version number) MQMHBO_VERSION_1 1
Options (options controlling the action of MQMHBUF) MQMHBO_PROPERTIES_IN_MQRFH2  
Notes:
  1. The value Null string or blanks denotes the null string in C, and blank characters in other programming languages.
  2. In the C programming language, the macro variable MQMHBO_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: 
    MQMHBO MyMHBO = {MQMHBO_DEFAULT};

Language declarations

C declaration for MQMHBO

typedef struct tagMQMHBO MQMHBO;
struct tagMQMHBO {
  MQCHAR4  StrucId;        /* Structure identifier */
  MQLONG   Version;        /* Structure version number */
  MQLONG   Options;        /* Options that control the action of
                              MQMHBUF */ 
};

COBOL declaration for MQMHBO

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

PL/I declaration for MQMHBO

Dcl
 1 MQMHBO 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 MQMHBUF */

High Level Assembler declaration for MQMHBO

MQMHBO                      DSECT
MQMHBO_STRUCID              DS   CL4  Structure identifier
MQMHBO_VERSION              DS   F    Structure version number
MQMHBO_OPTIONS              DS   F    Options that control the
*                                     action of MQMHBUF
MQMHBO_LENGTH               EQU  *-MQMHBO
MQMHBO_AREA                 DS   CL(MQMHBO_LENGTH)