The Retrieve Data Queue Description command retrieves the attributes
of a data queue into CL return variables.
A typical command would be entered as:
DCL &MAXLEN *DEC LEN(5 0)
.
RTVDTAQD DTAQ(xxx) MAXLEN(&MAXLEN)
The system provided API QMHQRDQD is used to access the attributes.
RTVDTAQD Command parameters *CMD
---------------------------
DTAQ The qualified file name of the file. The library
value The library value defaults to *LIBL. *CURLIB
may also be specified.
RTNLIB An optional return variable that will contain the
library name where the data queue was found. The
value may be helpful if the data queue is accessed
without a specific library name. If specified, the
variable must be declared as *CHAR LEN(10).
TYPE An optional return variable that will contain the
type of data queue either *STD or *DDM. If
specified, the variable must be declared as *CHAR
LEN(4).
OWNER An optional return variable that will contain the
owner of the data queue. If specified, the variable
must be declared as *CHAR LEN(10).
MAXLEN An optional return variable that will contain the
maximum length of an entry that can be stored in the
data queue. If specified, the variable must be
declared as *DEC LEN(5 0).
SEQ An optional return variable that will contain the
sequence of the data queue entries. The values
*FIFO, *LIFO, or *KEYED may be returned. If
specified, the variable must be declared as *CHAR
LEN(6).
KEYLEN An optional return variable that will contain the
key length of a keyed data queue. If non-keyed, the
value will be zero. If specified, the variable must
be declared as *DEC LEN(5 0).
TEXT An optional return variable that will contain the
text description of the data queue. If specified,
the variable must be declared as *CHAR LEN(50).
FORCE An optional return variable that will contain the
value of the FORCE parameter (*YES or *NO). If
specified, the variable must be declared as *CHAR
LEN(4).
SENDERID An optional return variable that will contain the
value of the SENDERID parameter (*YES or *NO). If
specified, the variable must be declared as *CHAR
LEN(4).
AUTORCL An optional return variable that will contain the
value of the AUTORCL parameter (*YES or *NO). *YES
means the data queue space is reclaimed if the
number of entries is 0. If specified, the variable
must be declared as *CHAR LEN(4).
NBRENT An optional return variable that will contain the
current number of entries in the data queue. If
specified, the variable must be declared as *DEC
LEN(5 0).
NBRENT2 An optional return variable that will contain the
current number of entries in the data queue. This
is the same as the NBRENT field, but allows for more
entries. If specified, the variable must be
declared as *DEC LEN(7 0).
NBRENT3 An optional return variable that will contain the
current number of entries in the data queue. This
is the same as the NBRENT field, but allows for more
entries. If specified, the variable must be
declared as *DEC LEN(11 0).
MAXENT An optional return variable that will contain the
maximum number of entries that may be placed in the
data queue without causing the data queue to
overflow. If specified, the variable must be
declared as *DEC LEN(5 0).
MAXENT2 An optional return variable that will contain the
maximum number of entries that may be placed in the
data queue without causing the data queue to
overflow. This is the same as the MAXENT field, but
allows for more entries. If specified, the variable
must be declared as *DEC LEN(7 0).
MAXENT3 An optional return variable that will contain the
maximum number of entries that may be placed in the
data queue without causing the data queue to
overflow. This is the same as the MAXENT field, but
allows for more entries. If specified, the variable
must be declared as *DEC LEN(11 0).
SIZE An optional return variable that will contain the
size of the data queue in bytes. If specified, the
variable must be declared as *DEC LEN(15 0).
ENFRCLOCK An optional return variable that will contain a *YES
or *NO for whether an IBM supported data queue will
enforce a lock. This value cannot be specified on
CRTDTAQ. If specified, the variable must be
declared as *CHAR LEN(4).
RMTDTAQ An optional return variable that will contain For
TYPE(*STD) data queues, this field will be blank.
If specified, the variable must be declared as *CHAR
LEN(10).
RMTDTAQL An optional return variable that will contain the
name of the remote data queue library. For
TYPE(*STD) data queues, this field will be blank.
If specified, the variable must be declared as *CHAR
LEN(10).
RMTLOCNAME An optional return variable that will contain the
name of the remote location name. For TYPE(*STD)
data queues, this field will be blank. If
specified, the variable must be declared as *CHAR
LEN(8).
DEV An optional return variable that will contain the
name of the APPC device name. For TYPE(*STD) data
queues, this field will be blank. If specified, the
variable must be declared as *CHAR LEN(8).
LCLLOCNAME An optional return variable that will contain the
name of the local location name. For TYPE(*STD)
data queues, this field will be blank. If
specified, the variable must be declared as *CHAR
LEN(8).
MODE An optional return variable that will contain the
mode. For TYPE(*STD) data queues, this field will
be blank. If specified, the variable must be
declared as *CHAR LEN(8).
RMTNETID An optional return variable that will contain the
remote network identifier. For TYPE(*STD) data
queues, this field will be blank. If specified, the
variable must be declared as *CHAR LEN(8).
Restrictions
------------
Because the command returns variables, it can only be used in a CL
program.
Prerequisites
-------------
None.
Implementation
--------------
None, the tool is ready to use.
Objects used by the tool
------------------------
Object Type Attribute Src member Src file
------ ---- --------- ---------- ----------
RTVDTAQD *CMD TAADTQE QATTCMD
TAADTQEC *PGM CLP TAADTQEC QATTCL
TAADTQER *PGM RPG TAADTQER QATTRPG
|
