INQUIRE TDQUEUE
(
name
)
ATIFACILITY (
cvda
)
ATITRANID (
data-area
) EMPTYSTATUS (
cvda
)
ATITERMID (
data-area
)
ENABLESTATUS (
cvda
)
INDIRECTNAME (
data-area
)
OPENSTATUS (
cvda
)
RECOVSTATUS (
cvda
)
IOTYPE
RECORDFORMAT
REMOTENAME
(
cvda
(
cvda
)
)
(
data-area
)
NUMITEMS (
data-area
RECORDLENGTH (
data-area
)
REMOTESYSTEM
)
(
data-area
)
TRIGGERLEVEL (
data-area
) TYPE (
cvda
)
Condition:
QIDERR
The EXEC CICS INQUIRE TDQUEUE command retrieves information about the named transient data queue definition in the CICS/400 control region.
Note:
For a closed extrapartition queue, the values that are returned can vary according to when the command is issued. For example, if the CICS transient data queue is closed when the command is issued, much of the information received describes the state of the CICS transient data queue when it is next opened. If the CICS transient data queue has never been opened, default or null values will be received for some of the options, that could change when the CICS transient data queue is opened.
Options
ATIFACILITY(cvda) (intrapartition queues only)
returns a CVDA value indicating whether or not the CICS task that is to be started when the TRIGGERLEVEL value is reached, is associated with a CICS terminal (or session). CVDA values are:
TERMINAL
A CICS terminal (or session) is associated with the CICS task that is to be started when the TRIGGERLEVEL value is reached.
NOTERMINAL
A CICS terminal (or session) is not associated with the CICS task that is to be started when the TRIGGERLEVEL value is reached.
ATITERMID(data-area) (intrapartition queues only)
returns a 4-character string representing the name of the terminal or session to be associated with the queue when automatic transaction initiation occurs. A null value is returned if the transaction does not need a terminal or session.
ATITRANID(data-area) (intrapartition queues only)
returns a 4-character string representing the name of the CICS transaction to be started when the TRIGGERLEVEL value is reached.
496
CICS for iSeries Application Programming Guide V5
EMPTYSTATUS(cvda) (intrapartition queues only)
returns a CVDA value indicating whether the queue is full, empty, or neither.
CVDA values are:
FULL
EMPTY
The TRIGGERLEVEL value has been reached.
The queue does not have data.
NOTEMPTY
The queue has data, but the TRIGGERLEVEL value has not been reached.
NOTAPPLIC
The queue is not enabled.
ENABLESTATUS(cvda) (all except indirect queues)
returns a CVDA value indicating whether CICS application programs can use the queue. CVDA values are:
ENABLED
The queue is available for use by CICS application programs.
DISABLED
The queue is unavailable for use by CICS application programs, although it may still be open.
INDIRECTNAME(data-area) (indirect queues only)
returns a 4-character string representing the name of the queue that this indirect queue points to, as specified in the PHYDEST parameter within the
OS/400 ADDCICSDCT CL command.
IOTYPE(cvda) (extrapartition queues only)
returns a CVDA value indicating whether records can be read or written to the queue. CVDA values are:
INPUT
Records can only be read from the queue, and only in a forward capacity.
Records can only be written to the queue.
OUTPUT
READBACK
Records can only be read from the queue, and only in a backward capacity.
NUMITEMS(data-area) (intrapartition queues only)
returns a fullword binary field representing the logical number of records in the queue.
OPENSTATUS(cvda) (extrapartition queues only)
returns a CVDA value indicating whether the queue is open, closed, or in a transitional state. CVDA values are:
OPEN
CLOSED
OPENING
CLOSING
The queue is open to have records read or written to it.
The queue is closed.
The queue is in the process of being opened.
The queue is in the process of being closed.
RECORDFORMAT(cvda)(extrapartition queues only)
returns a CVDA value indicating whether the queue has fixed- or variable-length records. CVDA values are:
FIXED
Records in the queue all have the same length.
VARIABLE
Records in the queue do not necessarily have the same length.
NOTAPPLIC
The specified queue is not enabled.
RECORDLENGTH(data-area) (extrapartition queues only)
returns a fullword binary field indicating the maximum record length for
Chapter 33. System programming reference
497
queues defined as VARIABLE, and the actual record length for queues defined as FIXED. The value returned is the number of bytes.
RECOVSTATUS(cvda) (intrapartition queues only)
returns a CVDA value indicating whether the queue is recoverable or not.
CVDA values are:
LOGICAL
The queue is recoverable.
NOTRECOVERABLE
The queue is not recoverable.
REMOTENAME(data-area) (remote queues only)
returns a 4-character string representing the name that this queue has in the remote system.
REMOTESYSTEM(data-area) (remote queues only)
returns a 4-character string representing the name of the remote system, if the queue is remote.
TDQUEUE(name)
is the name of the transient data queue (the destination) as specified in the
DEST parameter within the OS/400 ADDCICSDCT CL command. The name may be up to 4 characters long.
TRIGGERLEVEL(data-area) (intrapartition queues only)
returns a fullword binary field indicating the number of requests for output to the queue that there must be before automatic transaction initiation (ATI) can occur.
TYPE(cvda)
returns a CVDA value indicating the type of queue. CVDA values are:
EXTRA
INDIRECT
INTRA
REMOTE
The queue is an extrapartition transient data queue.
The queue is an indirect transient data queue.
The queue is an intrapartition transient data queue.
The queue is a remote transient data queue.
Exception Conditions
QIDERR
occurs if the named queue cannot be found (RESP2=1).
Default action: Terminate the task abnormally.
498
CICS for iSeries Application Programming Guide V5
