Parameter

Description

Queue Handle

Numeric (18). Input. The numeric value that was returned from the WMQ.Open Destination program.

TimeOut

Numeric (N10). Input. (Milliseconds). This is the time that the component waits for a message. A value of (-1) means infinite, meaning that the component waits until there is a message in the queue. This is the way to implement a listener.

Message

BLOB. Input.

Buffer Identifier Index

Numeric (4). Input. If the buffer identifier index is zero, the component sends the BLOB as-is. If it is greater than zero, the component will create the message buffer according to the structure, and values, in the memory table. For more information, see Buffer Table.

Transaction MSG

Logical (5). Input. When True, this will be part of a transaction. If there is no open transaction, WebSphere MQ automatically begins one.

Message ID

BLOB. Optional input and output. For input, this parameter reads a specific message based on its Message ID. For output, this parameter is used to get the Message ID of the message that was called.
Note: The maximum size is 24 bytes.

Correlation ID

BLOB. Optional input and output. Identifies the correlation ID in send and response messages. For Publish/Subscribe mode, Identifies subscriptions for a specific subscriber in a shared queue.
Note: The maximum size is 24 bytes.

Group ID

BLOB. Optional input and output. Identifies a group of messages to be processed together.
Note: The maximum size is 24 bytes.

For specifying a NULL Group ID, use the following keyword: MG_NULL_ID.

Seq Number

Numeric (N10). Specifies the sequence number of the message in the group. If this is zero and the Group ID has a value, the component will handle and increase the value accordingly.

Message Type

Numeric (1). Output. The valid values are:

• 1: Request

• 2: Response

• 4: Report

• 8: Message (MQ Datagram)

Returned Description

Alpha (100). Optional output, separated by commas; for example: Reply2QM, Reply2Q, Format, Sent Date, Sent Time

Code Page

Numeric (5). Output, the code page of the message.

WMQ Message Encoding

Numeric (N10). Output. The encoding type of an Alpha field. The valid values are:

• 1. ANSI

• 2. EBCIDIC

• 3. UNICODE

Get First Msg?

Logical (5). Input. Determines whether to read the first message in the queue or the next message in the sequence.

Feedback

Numeric (N10). Output. Description: Indicates the feedback code from a report type message. Click here for a list of the Feedback Codes.

Return value

Numeric. 0 for success and non-zero for failure.