putOptionsRecord

The putOptionsRecord property identifies a record variable that you can use to pass options that control writing to the message queue to the WebSphere® MQ system.

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

EGL programs call the WebSphere MQ MQPUT function to implement the add statement for a message queue record. The WebSphere MQ Put Message Options (MQPMO) structure is a parameter on the MQPUT call.

If you do not specify a putOptionsRecord property, EGL automatically builds a default MQPMO structure, setting MQGMO_SYNCPOINT or MQGMO_NO_SYNCPOINT in the OPTIONS field based on the includeMsgInTransaction property.

Table 1. Structure of the WebSphere MQ Put Message Options record (MQPMO)
Field Type Description
STRUCID CHAR(4) Structure identifier
VERSION INT Structure version number
OPTIONS INT Options for MQPUT or MQPUT1
TIMEOUT INT Reserved
CONTEXT INT Object handle of input queue
KNOWNDESTCOUNT INT Number of messages sent to local queues
UNKNOWNDESTCOUNT INT Number of messages sent to remote queues
INVALIDDESTCOUNT INT Number of messages that could not be sent
RESOLVEDQNAME CHAR(48) Name of destination queue
RESOLVEDQMGRNAME CHAR(48) Name of destination queue manager
RECSPRESENT INT Number of put messages or response records present
PUTMSGRECFIELDS INT Flags for present MQPMR fields
PUTMSGRECOFFSET INT Offset for put message record in MQPMO
RESPONSERECOFFSET INT Offset for response record in MQPMO
PUTMSGRECPTR INT Address of the first put message record
RESPONSERECPTR INT Address of the first response record

You can use the putOptionsRecord property to specify MQPMO or your own variable that is based on MQPMO. Code the program to initialize and set fields in the MQPMO record variable before accessing the queue. EGL uses your MQPMO 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