MQCMHO - Create message handle options

The MQCMHO structure allows applications to specify options that control how message handles are created. The structure is an input parameter on the MQCRTMH call.

Availability

The MQCMHO structure is available on the following platforms:
  • [AIX]AIX®
  • [IBM i]IBM® i
  • [Linux]Linux®
  • [Solaris]Solaris
  • [Windows]Windows
  • [z/OS]z/OS®
and with IBM MQ clients.

Character set and encoding

Data in MQCMHO 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. The child topics follow the same sequence.
Table 1. Fields in MQCMHO
Field name and description Name of constant Initial value (if any) of constant
StrucId (structure identifier) MQCMHO_STRUC_ID 'CMHO'
Version (structure version number) MQCMHO_VERSION_1 1
Options (options) MQCMHO_DEFAULT_VALIDATION 0
Notes:
  1. In the C programming language, the macro variable MQCMHO_DEFAULT contains the values that are listed in the table. It can be used in the following way to provide initial values for the fields in the structure:
    
    MQCMHO MyCMHO = {MQCMHO_DEFAULT};
    

Language declarations

C declaration for MQCMHO


struct tagMQCMHO {
  MQCHAR4   StrucId;         /* Structure identifier */
  MQLONG    Version;         /* Structure version number */
  MQLONG    Options;         /* Options that control the action of MQCRTMH */
};

COBOL declaration for MQCMHO


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

PL/I declaration for MQCMHO


dcl
 1 MQCMHO 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 MQCRTMH */

High Level Assembler declaration for MQCMHO


MQCMHO                DSECT
MQCMHO_STRUCID        DS   CL4   Structure identifier
MQCMHO_VERSION        DS   F     Structure version number
MQCMHO_OPTIONS        DS   F     Options that control the action of
*                                MQCRTMH
MQCMHO_LENGTH         EQU  *-MQCMHO
MQCMHO_AREA           DS   CL(MQCMHO_LENGTH)