The Retrieve Member Description 2 command retrieves additional
attributes that are not available on the system RTVMBRD command.
This includes the initial number of records, increment number of
records, maximum number of increments, and record capacity. 15 digit
values are returned for size parameters. See the RTVMBRSTAT command
for member statistics.
Some return fields (such as NBRCURRCD) are provided by RTVMBRD, but
are included in RTVMBRD2 for consistency.
A typical set of commands would be:
DCL &RCDCAP *DEC LEN(10 0)
DCL &NOMAX *CHAR LEN(4)
.
RTVMBRD2 FILE(xxx) NOMAX(&NOMAX) RCDCAP(&RCDCAP)
IF (&NOMAX *EQ '*NO') DO /* Chk rcd cap */
IF (&RCDCAP *LT nnn) DO /* LT ... */
.
ENDDO /* LT ... */
ENDDO /* Check record capacity */
RTVMBRD2 escape messages you can monitor for
--------------------------------------------
None. Escape messages from based on functions will be re-sent.
Command parameters *CMD
------------------
FILE The qualified name of the data base file to be
retrieved. The library value defaults to *LIBL.
*CURLIB may also be used.
MBR The member to be retrieved. The default is *FIRST.
RTNLIB An optional return variable for the file name. This
value may be helpful if a special value is used for
the qualified library name. If used, the variable
must be declared as *CHAR LEN(10).
RTNMBR An optional return variable for the member name.
This value may be helpful if a special value is used
for the MBR parameter. If used, the variable must
be declared as *CHAR LEN(10).
DTASPCSIZ An optional return variable for the size of the data
space. Logical files return 0. If used, the
variable must be declared as *DEC LEN(15 0).
ACCPTHSIZ An optional return variable for the size of the
access path space. If the file is not keyed, the
value is 0. If used, the variable must be declared
as *DEC LEN(15 0).
NBRCURRCD An optional return variable for the number of
current records in the member. A keyed logical file
returns the number of index entries. A non-keyed
logical file returns the number in the based-on
physical member. If used, the variable must be
declared as *DEC LEN(15 0).
NBRDLTRCD An optional return variable for the number of
deleted records in the member. A logical file
returns 0. If used, the variable must be declared
as *DEC LEN(15 0).
NOMAX An optional return variable for whether the member
has a *NOMAX value for the number of records that
may exist. A *YES or *NO will be returned. A
logical file returns *NO. If *YES is returned, the
return values for INLNBRRCD, INCNBRRCD, MAXNBRINC,
CURNBRINC, and RCDCAP will be 0. If used, the
variable must be declared as *CHAR LEN(4)
INLNBRRCD An optional return variable for the initial number
of records that can be placed in the member. If a
size of *NOMAX was specified, the return value will
be 0. A logical file always returns 0. If used,
the variable must be declared as *DEC LEN(10 0).
INCNBRRCD An optional return variable for the number of
records that are added on each increment. If a size
of *NOMAX was specified, the return value will be 0.
A logical file always returns 0. If used, the
variable must be declared as *DEC LEN(5 0).
MAXNBRINC An optional return variable for the maximum number
of increments that may be added to the member. If a
size of *NOMAX was specified, the return value will
be 0. A logical file always returns 0. If used,
the variable must be declared as *DEC LEN(5 0).
CURNBRINC An optional return variable for the current number
of increments that may exist for the member. If a
size of *NOMAX was specified, the return value will
be 0. A logical file always returns 0. If used,
the variable must be declared as *DEC LEN(5 0).
RCDCAP An optional return variable for the total record
capacity of the member based on the initial number
of records, the size of an increment, and the
maximum number of increments. If a size of *NOMAX
was specified, the return value will be 0. A
logical file always returns 0. If used, the
variable must be declared as *DEC LEN(10 0).
ACCPTHSHR Whether the access path is shared. If a logical
file member is specified, the value refers to the
first 'based on' physical file member. *NA is
returned if the value is not applicable such as an
arrival sequence file. *YES is returned if the
access path is shared. *NO is returned if the
access path is not shared. This is an optional
return variable that if used must be specified as
*CHAR LEN(4).
ACCPTHVLD Whether the access path is valid. If a logical file
member is specified, the value refers to the first
'based on' physical file member. *NA is returned if
the value is not applicable such as an arrival
sequence file. *YES is returned if the access path
is valid. *NO is returned if the access path is not
valid. This is an optional return variable that if
used must be specified as *CHAR LEN(4).
ACCPTHHLD Whether the access path is held. If a logical file
member is specified, the value refers to the first
'based on' physical file member. *NA is returned if
the value is not applicable such as an arrival
sequence file. *YES is returned if the access path
is held. *NO is returned if the access path is not
held. This is an optional return variable that if
used must be specified as *CHAR LEN(4).
Restrictions
------------
Because the command returns variables, it may only be used in a CL
program.
Prerequisites
-------------
The following TAA Tools must be on your system:
CHKOBJ3 Check object 3
Implementation
--------------
None, the tool is ready to use.
Objects used by the tool
------------------------
Object Type Attribute Src member Src file
------ ---- --------- ---------- ----------
RTVMBRD2 *CMD TAADBJT QATTCMD
TAADBJTC *PGM CLP TAADBJTC QATTCL
|
