Retrieve information about a temporary storage queue.
This section applies also to the alternative command, INQUIRE TSQNAME Use either to Inquire about names up to 8 characters long, use INQUIRE TSQNAME to Inquire about names up to 16 characters long.
INQUIRE TSQUEUE >>-INQUIRE --+-TSQUEUE(data-value)-+----------------------------> '-TSQNAME(data-value)-' .----------------------------. V | >--+----------------------+----+------------------------+-+---->< +-POOLNAME(data-value)-+ +-FLENGTH(data-area)-----+ '-SYSID(data-value)----' +-LASTUSEDINT(data-area)-+ +-LOCATION(cvda)---------+ +-MAXITEMLEN(data-area)--+ +-MINITEMLEN(data-area)--+ +-NUMITEMS(data-area)----+ +-RECOVSTATUS(cvda)------+ '-TRANSID(data-area)-----'
Conditions: END, ILLOGIC, INVREQ, NOTAUTH, POOLERR, QIDERR, SYSIDERR
For more information about the use of CVDAs, see CICS-value data areas (CVDAs).
The INQUIRE TSQUEUE command returns information about a particular temporary storage queue.
You can also browse through all of the temporary storage queues in your system by using the browse options (START, AT, NEXT, and END) on INQUIRE TSQUEUE commands. In browse mode, the definitions are returned in alphabetic order, and you can specify a starting point with the AT option if you wish. If you want to see all the queues with names beginning with a certain string of letters, for example, you can start your browse with an AT value of those letters, padded on the right to eight characters with nulls (X'00'). If you want to browse TS queues that are in a shared temporary storage pool managed by a TS server, you must specify the POOLNAME or the SYSID option on the browse START request only. If CICS cannot find the specified SYSID in any temporary storage table (TST) TYPE=SHARED entry, CICS returns the INVREQ condition.
In a browse, CICS returns all queues, and you may see queues created by CICS for internal use as well as those created by user applications. In particular, queues with names that start with these characters are CICS queues: ‘**’, ‘$$’, X'FA' through X'FF', ‘CEBR’ and ‘DF’.
See Browsing resource definitions for general information about browsing, including syntax, exception conditions, and examples.
For shared queues only: When the whole shared queue has been stored in a single entry in the coupling facility (in which case the returned value for FLENGTH is less than 32K (32768)), this is the total size of all items including their control information.
When the shared queue has been stored as a separate list in the coupling facility, the total size is estimated as MAXITEMLEN times NUMITEMS.
The value returned for ‘large’ shared temporary storage queues is governed by the value of the LASTUSEDINTERVAL parameter specified for the associated TS queue manager (see the CICS® System Definition Guide for further information).
The length of a queue item is the sum of the length of the user data plus 8 bytes for header information, rounded up. For main storage queues, the length is rounded up to the boundary of the MVS storage subpool used to store it.
For auxiliary temporary storage, the length is rounded to the next highest multiple of either 64 or 128 (depending on the control interval size of the temporary storage data set). (For background information about CI sizes, see the CICS System Definition Guide.)
For shared queues, the lengths returned in MINITEMLEN, MAXITEMLEN, and FLENGTH, reflect the data length stored in the coupling facility. This includes any item control information, which consists of a 2-byte length prefix for each item.
For all
types of queue the maximum value returned will be capped at 32767 (Hex '7FFF').
For browse operations, specify POOLNAME on the browse START request only, not on the NEXT or END requests.
For browse operations, specify SYSID on the browse START request only, not on the NEXT or END requests.