MQCTLO - Control callback options structure

The MQCTLO structure is used to specify options relating to a control callbacks function. The structure is an input and output parameter on the MQCTL call.

Availability

The MQCTLO structure is available on the following platforms:

AIX®
IBM® i
Linux®
Solaris
Windows
z/OS®

and for IBM MQ MQI clients connected to these systems.

Version

The current version of MQCTLO is MQCTLO_VERSION_1.

Character set and encoding

Data in MQCTLO must be in the character set given by the CodedCharSetId queue manager attribute and encoding of the local queue manager given by MQENC_NATIVE. However, if the application is running as an MQ MQI client, the structure must be in the character set and encoding of the client.

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 MQCTLO
Field name and description	Name of constant	Initial value (if any) of constant
StrucID (structure identifier)	MQCTLO_STRUC_ID	`'CTLO'`
Version (structure version number)	MQCTLO_VERSION_1	`1`
Options (options)	MQCTLO_NONE	Nulls
Options (reserved field)	Reserved field
ConnectionArea (field for callback function to use)	None	Null pointer or null bytes
Notes: In the C programming language, the macro variable MQCTLO_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: `MQCTLO MyCTLO = {MQCTLO_DEFAULT};`

Language declarations

C declaration for MQCTLO


typedef struct tagMQCTLO MQCTLO;
 struct tagMQCTLO {
  MQCHAR4   StrucId;        /* Structure identifier */
  MQLONG    Version;        /* Structure version number */
  MQLONG    Options;        /* Options that control the action of MQCTL */
  MQLONG    Reserved;       /* Reserved field */
  

MQPTR     ConnectionArea; /* Connection work area passed to the function */
 };

COBOL declaration for MQCTLO


** MQCTLO structure
 10  MQCTLO.
** Structure Identifier
 15  MQCTLO-STRUCID                      PIC X(4).
** Structure Version
 15  MQCTLO-VERSION                      PIC S9(9) BINARY.
 ** Options
 15  MQCTLO-OPTIONS                      PIC S9(9) BINARY.
** Reserved
 15  MQCTLO-RESERVED                     PIC S9(9) BINARY.
** ConnectionArea
 15  MQCTLO-CONNECTIONAREA               POINTER

PL/I declaration for MQCTLO


dcl
 1 MQCTLO based,
  3 StrucId             char(4),       /* Structure identifier */
  3 Version             fixed bin(31), /* Structure version */
  3 Options             fixed bin(31), /* Options */
  3 Reserved            fixed bin(31), 
  3 ConnectionArea      pointer;       /* Connection work area */