MQ Extended Get

This WebSphere MQ tool executes the MQGET call to retrieve a message from a local queue that has been opened using the MQOPEN call. See the MQGET call documentation in your WebSphere MQ Application Programming Guide for more information.

The function of MQ Extended Get is identical to MQ Get, except that MQ Extended Get returns all MQGET call output parameters while MQ Get returns only the most commonly used output parameters.

Inputs

Hconn

The connection handle to the Queue Manager. The MQConnect tool generates this connection handle. This value corresponds to the Hconn input parameter in the MQGET call.

Hobj

The object handle identifying the queue from which a message is retrieved. The Hobj is generated by the MQ Open tool. This value corresponds to the Hobj parameter in the MQGET call.

Options (MQGMO)

Options that control the action of MQGET. See MQGMO - Get-Message options in the MQSeries Application Programming Reference guide for a list of valid options. This value corresponds to the GetMesgOpts parameter in the MQGET call.

WaitInterval (MQGMO)

The approximate time, expressed in milliseconds, that the MQGET call waits for a suitable message to arrive..

Search MsgId

See the Message-Identifier options in the MQMD - Message Descriptor documentation for more information on setting this value.

Search CorelId

See the Correlation-Identifier options in the MQMD - Message Descriptor documentation for more information on setting this value.

Max. Message Length Estimate

The maximum message length in bytes. See MaxMsgLength in the Attributes for Local Queues and Model Queues for more information on setting this value.

Buffer handle

If your message to get is a binary buffer constructed via the Buffer Tools, pass in the buffer handle here. Any non-zero number in the Buffer Handle implies a binary buffer.  Set the Buffer Handle to 0 for a text buffer.

Outputs

Note: The values of the following output parameters are defined in the MQMD - Message Descriptor portion of the WebSphere MQ Application Programming Guide.

Message

If your message to get is all textual, pass in an empty string here; it will be filled-in with the message contents on return. Note: The Buffer Tools also support textual buffers, but it is generally easier to use a string for this.

See the cross-reference note above.

Report

See note above.

MsgType

See note above.

Expiry

See note above.

Feedback

See note above.

Format

See note above.

Encoding

See note above.

CodedCharSetId

See note above.

Priority

See note above.

Persistence

See note above.

MsgId

See note above.

CorelId

See note above.

BackoutCount

See note above.

ReplyToQ

See note above.

ReplyToQMgr

See note above.

UserIdentifier

See note above.

AccountingToken

See note above.

ApplIdentityData

See note above.

PutApplType

See note above.

PutApplName

See note above.

PutDate

See note above.

PutTime

See note above.

ApplOriginData

See note above.

ResolvedQName (MQGMO)

See note above.

Reason Code

For each call, a completion code and a reason code are returned by the queue manager or by an exit routine, to indicate the success or failure of the call. This value corresponds to the Reason code parameter in the MQGET call. The WebSphere MQ Application Programming Guide contains a list of reason codes and their meanings.

Exit Paths

Success

This step takes the Success exit path if the completion code indicates success.

Failure

This step takes the Failure exit path if the completion code indicates failure. The reason for tool failure is contained in the Reason Code parameter.