MQBO - Begin options

The MQBO structure allows the application to specify options relating to the creation of a unit of work. The structure is an input/output parameter on the MQBEGIN call.

Availability

The MQBO structure is available on the following platforms:

AIX®
IBM® i
Linux®
Windows

The MQBO structure is not available for IBM MQ MQI clients.

Character set and encoding

Data in MQBO 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.

Table 1. Fields in MQBO for MQBO
Field name and description	Name of constant	Initial value (if any) of constant
StrucId (structure identifier)	MQBO_STRUC_ID	`'BO¬¬'`
Version (structure version number)	MQBO_VERSION_1	`1`
Options (options that control the action of MQBEGIN)	MQBO_NONE	`0`
Notes: The symbol `¬` represents a single blank character. In the C programming language, the macro variable MQBO_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: `MQBO MyBO = {MQBO_DEFAULT};`

Language declarations

C declaration for MQBO

typedef struct tagMQBO MQBO;
struct tagMQBO {
  MQCHAR4  StrucId;  /* Structure identifier */
  MQLONG   Version;  /* Structure version number */
  MQLONG   Options;  /* Options that control the action of MQBEGIN */
};

COBOL declaration for MQBO

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

PL/I declaration for MQBO

dcl
 1 MQBO 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
                              MQBEGIN */

Visual Basic declaration for MQBO

Type MQBO
  StrucId As String*4 'Structure identifier'
  Version As Long     'Structure version number'
  Options As Long     'Options that control the action of MQBEGIN'
End Type