TSSH gate, INQUIRE_QUEUE function
Inquire on the attributes of a temporary storage queue.
Input Parameters
- QUEUE_NAME
- The name of the queue.
- KEY_COMPARISON
- Optional Parameter
- Specifies the constraints on the inquiry.
- Values for the parameter are:
- EQ
- GT
- GTEQ
- POOL_TOKEN
- Optional Parameter
- A token that identifies a pool containing the specified queue.
- TRANSACTION_NUMBER
- Optional Parameter
- The 4-byte transaction number (in packed-decimal format).
Output Parameters
- REASON
- The following values are returned when RESPONSE is EXCEPTION:
- IO_ERROR
- QUEUE_NOT_FOUND
- SERVER_ERROR
- RESPONSE
- Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.
- LAST_REFERENCED_TIME
- Optional Parameter
- The time at which the queue was last referenced.
- MAXIMUM_ITEM_LENGTH
- Optional Parameter
- The length of the longest item in the queue.
- MINIMUM_ITEM_LENGTH
- Optional Parameter
- The length of the shortest item in the queue.
- OUTPUT_QUEUE_NAME
- Optional Parameter
- The name of the queue whose information is returned. Note that this might differ from QUEUE_NAME unless KEY_COMPARISON(EQ) is specified.
- TOTAL_ITEMS
- Optional Parameter
- The total number of items in the queue.
- TOTAL_LENGTH
- Optional Parameter
- The sum of the lengths of all the items in the queue.
- TRANSID
- Optional Parameter
- The identifier of the transaction that created the queue.