MQSRO - Subscription request options

The MQSRO structure allows the application to specify options that control how a subscription request is made. The structure is an input/output parameter on the MQSUBRQ call.

Availability

The MQSRO structure is available on the following platforms:

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

and for IBM MQ MQI clients connected to these systems.

Version

The current version of MQSRO is MQSRO_VERSION_1.

Character set and encoding

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

Field name and description	Name of constant	Initial value (if any) of constant
StrucId (structure identifier)	MQSRO_STRUC_ID	`'SRO¬'`
Version (structure version number)	MQSRO_VERSION_1	`1`
Options (options)	MQSRO_NONE	`0`
NumPubs (number of publications)	None	`0`
Notes: The symbol `¬` represents a single blank character. In the C programming language, the macro variable MQSRO_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: `MQSRO MySRO = {MQSRO_DEFAULT};`

Language declarations

C declaration for MQSRO

typedef struct tagMQSRO MQSRO;
struct tagMQSRO {
  MQCHAR4   StrucId;              /* Structure identifier */
  MQLONG    Version;              /* Structure version number */
  MQLONG    Options;              /* Options that control the action of MQSUBRQ */
  MQLONG    NumPubs;              /* Number of publications sent */
  /* Ver:1 */
};

COBOL declaration for MQSRO

** MQSRO structure
 10  MQSRO.
** Structure identifier
 15  MQSRO-STRUCID             PIC X(4).
** Structure version number
 15  MQSRO-VERSION             PIC S9(9) BINARY.
** Options that control the action of MQSUBRQ
 15  MQSRO-OPTIONS             PIC S9(9) BINARY.
** Number of publications sent
 15  MQSRO-NUMPUBS             PIC S9(9) BINARY.

PL/I declaration for MQSRO

dcl
 1 MQSRO 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 MQSUBRQ */
  3 NumPubs        fixed bin(31); /* Number of publications sent */

High Level Assembler declaration for MQSRO

MQSRO                    DSECT
MQSRO_STRUCID            DS    CL4   Structure identifier
MQSRO_VERSION            DS    F     Structure version number
MQSRO_OPTIONS            DS    F     Options that control the action of MQSUBRQ
MQSRO_NUMPUBS            DS    F     Number of publications sent
*
MQSRO_LENGTH             EQU   *-MQSRO
                         ORG   MQSRO
MQSRO_AREA               DS    CL(MQSRO_LENGTH)