getOptionsRecord

The getOptionsRecord property identifies a record that you can use to pass options that control reading from a WebSphere® MQ message queue.

The record that the property identifies is based on a BasicRecord.

EGL programs call the WebSphere MQ MQGET function to implement the get next option for a message queue record. The WebSphere MQ Get Message Options structure (MQGMO) is a parameter on the MQGET call.

If you do not specify a getOptionsRecord property, EGL automatically builds a default MQGMO structure, setting MQGMO_SYNCPOINT or MQGMO_NO_SYNCPOINT in the OPTIONS field. EGL bases the sync point option on the includeMsgInTransaction property.

Table 1. Structure of the WebSphere MQ Get Message Options record (MQGMO)
Field Type Description
STRUCID CHAR(4) Structure identifier
VERSION INT Structure version number
OPTIONS INT Options that control MQGET
WAITINTERVAL INT Wait interval
SIGNAL1 INT Signal
SIGNAL2 INT Signal identifier
RESOLVEDQNAME CHAR(48) Name for destination queue
MATCHOPTIONS INT Options for MQGET criteria
GROUPSTATUS CHAR(1) Flag: message is in a group
SEGMENTSTATUS CHAR(1) Flag: segment logical message
SEGMENTATION CHAR(1) Flag: segmentation allowed
RESERVED1 CHAR(1) Reserved

You can use the getOptionsRecord property to specify MQGMO or your own variable based on MQGMO. Before you access the queue, code the program to initialize and set fields in the MQGMO record variable. EGL uses your MQGMO structure instead of the default structure.

For more information about options records, see Options records for MQRecords. For a complete list of WebSphere MQ constants (such as MQGMO_SYNCPOINT), refer to your WebSphere MQ documentation.


Feedback