This program receives a message with a header, returns the message, and also returns the Datatype. The parameters and return value for the WMQ.GetMessageWithHeader program are:
|
|
|
|
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, containing the message data.
|
|
Buffer Identifier index
|
Numeric (4). Input. When this parameter evaluates to zero, the message must be in the BLOB. If it evaluates to greater than zero, the message structure and values are in the memory table, the Buffer Table, and this is the index. 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 specifies a specific Message ID. For output, this parameter receives the Message ID of the message that was sent.
Note: The maximum size is 24 bytes.
|
|
Correlation ID
|
BLOB. Optional input and output. For input, this parameter specifies a specific Correlation ID. For output, this parameter receives the Correlation ID of the message that was sent.
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. 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). Input. The Message Type parameter specifies the message type:
-
0: Message (MQ Datagram)
-
1: Request
-
2: Response
The component sends messages according to the specified Message Type. This parameter is not relevant for Publish.
|
|
Returned Description
|
Alpha (100). Optional output, separated by commas; for example: Reply2QM, Reply2Q, Format, Sent Date, Sent Time
|
|
Code Page
|
Numeric (5). Optional input. The code page that should be used for message encoding. When this parameter is not passed, the value fetched will be from the Global setting. If the global value has not been set in the Global Setup program or the Logical Name, an error is returned.
|
|
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.
|
|
MQMsgHeader
|
BLOB. Optional input. If the message format is 7, the header BLOB must be in the format of an RFH2 structure. To populate the header, use WMQ.GetRFH2Header.
|
|
IsMessageHeader
|
Logical (5). Input. Determines whether to check if the message includes a header.
|
|
Save to File?
|
Numeric (1). Input. Determines whether to save the file. 0=No, 1=Yes.
|
|
FilePath
|
Alpha (1000). Input/Output. A valid file path.
|
