Get Queue Info (Magic xpa 3.x)
The WMQ_GetqueueInfo program returns the actual WebSphere MQ information when the host application needs to perform unsupported actions. The parameters and return value for the Get Queue Info program are:
|
|
Queue Handle
|
Numeric (18). Input. The numeric value that was returned from the WMQ.Open Destination program
|
Connection ID
|
Numeric (18). Output. The connection handle to the WebSphere MQ Queue.
|
Messaging System
|
Alpha (1). Output. This parameter always returns W, for WebSphere MQ
|
Queue Manager Name
|
Alpha (48). Output. The name of the MQ Queue Manager, which is part of the MQ installation
|
Queue Name
|
Alpha (48). Output. The name of the Queue.
|
Access Mode
|
Alpha (1). Output. A character representing the access. The valid values are:
-
W: Write. Messages are written to the queue.
-
R: Read. Messages are read and removed from the queue.
-
P: Publish. Messages are published to a Topic.
-
S: Subscribe. Messages are subscribed to a Topic.
|
Broker Stream
|
Alpha (50). Output. The broker stream, for example: SAMPLE.BROKER.RESULTS.STREAM
|
Topic
|
Alpha (50). Output. The topic that was subscribed to.
|
Unsubscribe on Close
|
Logical (5). Output. If True, the component will automatically unsubscribe from this topic when the queue is closed. This also means that when the component ends, it will unbsubscribe from the topic.
|
Correlation ID
|
BLOB. Output. Identifies the correlation for Request messages. Identifies subscriptions for a specific subscriber in a shared queue. Note: The maximum size is 24 bytes.
|
Disconnect on Close
|
Logical (5). Output. Defines whether a disconnect will be issued automatically after the WMQ queue is closed. The valid values are:
-
Y – auto disconnect
-
N – ignore this entry
|
Return value
|
Numeric. 0 for success and a non-zero value for failure.
|