Retrieves information about a transient data queue.

Sintaxe:

INQUIRE TDQUEUE
 
                          .-----------------------------.
                          V                             |
>>-INQUIRE TDQUEUE(name)----+-------------------------+-+------><
                            +-ATIFACILITY(cvda)-------+
                            +-ATITERMID(data-area)----+
                            +-ATITRANID(data-area)----+
                            +-ATIUSERID(data-area)----+
                            +-BLOCKFORMAT(cvda)-------+
                            +-EMPTYSTATUS(cvda)-------+
                            +-ENABLESTATUS(cvda)------+
                            +-INDIRECTNAME(data-area)-+
                            +-IOTYPE(cvda)------------+
                            +-NUMITEMS(data-area)-----+
                            +-OPENSTATUS(cvda)--------+
                            +-PRINTCONTROL(cvda)------+
                            +-RECORDFORMAT(cvda)------+
                            +-RECORDLENGTH(data-area)-+
                            +-RECOVSTATUS(cvda)-------+
                            +-REMOTENAME(data-area)---+
                            +-REMOTESYSTEM(data-area)-+
                            +-TRIGGERLEVEL(data-area)-+
                            '-TYPE(cvda)--------------'
 
 

For more information about the use of CICS-value data areas (CVDAs), see Appendix F, CVDAs recognized by the translator.

Descrição:

The INQUIRE TDQUEUE command retrieves information about a named transient data queue from the runtime Transient Data Definitions (TDD).
The queue can be on a local region or on a remote region.

Transient data queues, also called destinations, are defined in the destination control table (DCT) of CICS.
Two basic types are possible: intrapartition and extrapartition.
Intrapartition queues are managed and stored entirely by CICS, and are subject to automatic task initiation (ATI).
ATI means that when the number of items on the queue reaches the value that is in the TRIGGERLEVEL option, CICS automatically creates a task to process the queue.

An extrapartition queue is an Open Systems or Windows sequential file or device.
Extrapartition queues are not subject to ATI, and consequently the associated options produce null values.

Note:

For an extrapartition queue, many attributes can be assessed correctly only when the queue is open.
A null value is returned if the queue is either closed or in an intermediate state.
Also, any attribute that is not applicable to the queue that is named in the command is returned as a null value.

Two other queue types appear in the TD stanza definition: indirect and remote, both of which point, eventually, to one of the basic types.
An indirect queue points to another queue that is on the same CICS system, and is essentially an alias for the other queue.
When you name an indirect queue in an INQUIRE TDQUEUE command, CICS returns only the TYPE value (which is INDIRECT) and the name of the queue to which the indirect definition points (the INDIRECTNAME value).
You must issue a second INQUIRE TDQUEUE command against the INDIRECTNAME value to determine the characteristics of the underlying queue.

A remote queue is a queue that is defined on another CICS system.
When you inquire about such a queue, the local CICS system returns only the information that it maintains locally about the queue: the TYPE (REMOTE), the system on which it is defined (the REMOTESYSTEM value), its name there (REMOTENAME), and whether it is available to applications on the local system (its ENABLESTATUS).

You can also browse through all the transient data queues that are defined in your system by using the browse options (START, NEXT, and END) on INQUIRE TDQUEUE commands.

Opção:

ATIFACILITY(cvda)
• This option is for intrapartition queues only.
• This option returns a CVDA value of TERMINAL or NOTERMINAL.
• The value indicates whether the task that is to be started when the ATI queue's trigger level is reached is associated with a terminal (or session).
• If the task has an associated terminal and the queue's trigger level has been reached, the terminal is assigned as the principal facility of the task.
• Also, see the ATITERMID and ATITRANID options.
• The CVDA values are:
  • NOTAPPLIC
    • The queue is not an intrapartition queue.
  • NOTERMINAL
    • No terminal is associated with the queue.
  • TERMINAL
    • A terminal is associated with the queue.

ATITERMID(data-area)
• This option is for intrapartition queues only.
• This option returns a four-character string that represents the name of the terminal or session that is to be associated with this queue when ATI occurs.
• A null value is returned if the transaction does not need a terminal or session, or if the queue is not an intrapartition queue.

ATITRANID(data-area)
• This option is for intrapartition queues only.
• This option returns a four-character string that represents the name of the transaction that is to be started when this queue's trigger level is reached.
• This option applies only to intrapartition queues that are intended for ATI; for other types of queues, and for intrapartition queues where no transaction has been specified in the queue definition, a null value is returned.

ATIUSERID(data-area)
• This option is for intrapartition queues only.
• This option returns an eight-character string that represents the name of the user that is associated with this queue.
• TXSeries for Multiplatforms always returns a null for this value.

BLOCKFORMAT(cvda)
• This option is for extrapartition queues only.
• This option returns a CVDA value that indicates whether the data set that is associated with the queue is in blocked record format.
• CVDA values are:
  • BLOCKED
    • The records are blocked.
  • NOTAPPLIC
    • The data set is not open, or the queue is not an extrapartition queue.
  • UNBLOCKED
    • The records are not blocked.
• NOTAPPLIC or UNBLOCKED is always be returned with TXSeries for Multiplatforms.

EMPTYSTATUS(cvda)
• This option is for extrapartition queues only.
• This option returns a CVDA value that indicatesw the state of available space in the queue.
• Possible CVDA values are EMPTY, FULL, and NOTEMPTY.
• NOTAPPLIC is returned if the named queue is not open.
• CICS detects a FULL condition only when a task attempts to add a record and no space is available, and detects EMPTY only when a task attempts to read and no records exist.
• Consequently, a value of NOTEMPTY is returned unless one of these conditions has been detected.
• The CVDA values are:
  • EMPTY
    • The queue is empty.
  • FULL
    • The queue is full.
  • NOTAPPLIC
    • The option does not apply because the queue is not open or is not extrapartition.
  • NOTEMPTY
    • No operation against the queue has indicated that it is either empty or full.

ENABLESTATUS(cvda)
• This option is for all except indirect queues.
• This option indicates whether the queue can be accessed by applications.
• The CVDA values are:
  • ENABLED
    • The queue can be accessed by application.
  • DISABLED
    • The queue cannot be accessed by applications.
    • However, it can possibly still be open.
  • NOTAPPLIC
    • The named queue is an indirect queue.

INDIRECTNAME(data-area)
• This option is for indirect queues only.
• This option returns a four-character string that represents the name of the queue to which this INDIRECT queue points.
• A null value is returned if the queue is not an indirect queue.

IOTYPE(cvda)
• This option is for extrapartition queues only.
• This option indicates whether the queue was defined for input or output respectively.
• A value of NOTAPPLIC is returned if the queue is not open or is not an extrapartition queue.
• The CDVA values are:
  • INPUT
    • The queue is defined for input.
  • OUTPUT
    • The queue is defined for output.
  • NOTAPPLIC
    • The queue is not open or is not an extrapartition queue.

NUMITEMS(data-area)
• This option is for intrapartition queues only.
• This option returns a 32-bit binary field that indicates the number of logical records that are in the queue.
• A null value is returned if the named queue is not an intrapartition queue.
• Because the actual null value returned depends on the format of the user-defined data area, see Null values for a full description of the different types of null values.

OPENSTATUS(cvda)
• This option is for extrapartition queues only.
• This option returns a CVDA value that indicates whether the queue is open or closed.
• The CVDA values are:
  • OPEN
    • The queue is open.
  • CLOSED
    • The queue is closed.
  • NOTAPPLIC
    • The queue is not an extrapartition queue.

PRINTCONTROL(cvda)
• This option is for extrapartition queues only.
• This option returns a CVDA value that indicates the type of print control, if any, that is desired for the queue.
• When used, printer control characters appear in the first position of every record.
• However, CICS does not check this character when records are written to the queue, or remove this character when records are read from the queue.
• Use and enforcement of the printer control conventions are controlled by the application that is using the queue.
• CVDA values are:
  • ASACTL
    • ASA control characters are used.
  • MCHCTL
    • Machine control characters are used.
  • NOCTL
    • No print control characters are used.
  • NOTAPPLIC
    • The queue is not open or is not an extrapartition queue.
• The values NOCTL and NOTAPPLIC are always returned with TXSeries for Multiplatforms.

RECORDFORMAT(cvda)
• This option is for extrapartition queues only.
• This option indicates whether the queue has fixed-length or variable-length records.
• NOTAPPLIC is returned if the named queue is not open.
• The CDVA values are:
  • FIXED
    • The queue has fixed-length records.
  • VARIABLE
    • The queue has variable-length records.
  • NOTAPPLIC
    • The named queue is not open.

RECORDLENGTH(data-area)
• This option is for extrapartition queues only.
• This option returns a 32-bit binary field that indicates the maximum record length for queues that are defined as VARIABLE, and the actual record length for queues that are defined as FIXED.
• The returned value is the number of bytes.
• A null value is returned if the named queue is not open or is not an extrapartition queue.

RECOVSTATUS(cvda)
• This option is for intrapartition queues only.
• This option indicates whether the queue is physically recoverable, logically recoverable, or not recoverable.
• The CVDA values are:
  • PHYSICAL
    • The queue is physically recoverable.
  • LOGICAL
    • The queue is logically recoverable.
  • NOTRECOVABLE
    • The queue is not recoverable.
  • NOTAPPLIC
    • The queue is not an intrapartition queue.

REMOTENAME(data-area)
• This option is for remote queues only.
• This option returns a four-character string that represents the name of this queue in the remote region in which the queue is defined.
• The name is obtained from the Remote Name option that is in the Destination Control Table (DCT).
• The REMOTENAME option applies only to queues that are defined as remote; for other types of queues, a null value is returned.

REMOTESYSTEM(data-area)
• This option is for remote queues only.
• This option returns a four-character string that represents the name of the associated remote region in which the queue is defined.
• The name is obtained from the Remote Sysid option that is in the DCT).
• The REMOTESYSTEM option applies only to queues that are defined as remote; for other types of queues, a null value is returned.

TDQUEUE(name)
• Specifies the name of the transient data queue as defined in the Transient Data Definitions (TDD).
• The name can be up to four characters long.

TRIGGERLEVEL(data-area)
• This option is for intrapartition queues only.
• This option returns a 32-bit binary field that indicates the number of output requests that must be placed into the queue before automatic transaction initiation (ATI) can occur.
• A null value is returned if the named queue is not intrapartition.
• Because the actual null value returned depends on the format of the user-defined data area, see Null values for a full description of the different types of null values.
• Zero is returned if the queue is not subject to ATI.

TYPE(cvda)
• This options returns a CVDA value that indicates whether the queue is intrapartition, extrapartition, remote, or indirect.
• Possible CVDA values are:
  • INTRA
    • The queue is an intrapartition queue.
  • EXTRA
    • The queue is an extrapartition queue.
  • REMOTE
    • The queue is a remote queue.
  • INDIRECT
    • The queue is an indirect queue.

Condições:

END
• Occurs if no more resource definitions of this type (RESP2=2) exist.

ILLOGIC
• Occurs if you have issued a START command when a browse of this resource type is already in progress, or you have issued a NEXT or an END command when a browse of this resource type is not in progress (RESP2=1).

NOTAUTH
• Occurs if a resource security check has failed on TDQUEUE(name).
• Default action: Terminates the task abnormally.

QIDERR
• Occurs if the named queue cannot be found in the TDD (RESP2=1).