RTVLFMD RETRIEVE LOGICAL FILE MBR DESCRIPTION TAADBKP |
The Retrieve Logical File Member Description command retrieves
information about a logical file member. The 'based on' PF
information is retrieved for the first physical member. The QUSRMBRD
API is used.
A typical command would be:
DCL &NBRRCDS *DEC LEN(15 0)
.
RTVLFMD FILE(xxx) NBRRCDS(&NBRRCDS)
The number of records in the logical file member would be returned.
RTVLFMD escape messages you can monitor for
-------------------------------------------
TAA9891 The file is not a logical file
TAA9892 The file is not a data type
Escape messages from based on functions will be re-sent.
Command parameters *CMD
------------------
FILE The qualified name of the logical file to retrieve
member information for. The library value defaults
to *LIBL. *CURLIB may also be used.
MBR The member to retrieve information for. The default
is *FISRT. A specific member or *LAST may also be
specified.
RTNLIB The library where the file was found. This may be
helpful if *LIBL was used as the qualified file
name. This is an optional return variable that if
used must be specified as *CHAR LEN(10).
RTNMBR The member that information was retrieved for. This
may be helpful if *FIRST or *LAST was used as the
member name. This is an optional return variable
that if used must be specified as *CHAR LEN(10).
ACCPTHTYP The type of access path. The value will be K=Keyed
or A=Arrival. This is an optional return variable
that if used must be specified as *CHAR LEN(1).
KEYFLDS The number of key fields defined for the file. If
an arrival sequence access path exists, the number
of key fields will be returned as 0. This is an
optional return variable that if used must be
specified as *DEC LEN(3 0).
KEYLEN The maximum key length defined for the file. If an
arrival sequence access path exists, the key length
will be returned as 0. This is an optional return
variable that if used must be specified as *DEC
LEN(5 0).
ALTCOL Whether an alternate collating sequence is defined
for the file. A *YES or *NO value will be returned.
This is an optional return variable that if used
must be specified as *CHAR LEN(4).
ACCPTHSIZ The size of the access path. If an arrival sequence
access path exists, the access path size will be
returned as 0. This is an optional return variable
that if used must be specified as *DEC LEN(15 0).
ACCPTHMTN The maintenance type of the access path. A value of
*IMMED, *DLY, or *REBLD will be returned. This is
an optional return variable that if used must be
specified as *CHAR LEN(10).
NBRRCD The number of records on the access path. This is
an optional return variable that if used must be
specified as *DEC LEN(15 0).
RCDFMT The record format used. This is an optional return
variable that if used must be specified as *CHAR
LEN(10).
NBRBASEDON The number of 'based on' physical members. If the
value is 1, the BASEONPFx parameters will reflect
the only 'based on' physical. If the value is
greater than 1, only the first 'based on' physical
will be returned. This is an optional return
variable that if used must be specified as *DEC
LEN(5 0).
BASEDONPF The first 'based on' PF. This is an optional return
variable that if used must be specified as *CHAR
LEN(10).
BASEDONPFL The library of the first 'based on' PF. This is an
optional return variable that if used must be
specified as *CHAR LEN(10).
BASEDONPFM The member of the first 'based on' PF member. This
is an optional return variable that if used must be
specified as *CHAR LEN(10).
ACCPTHSHR Whether the access path is shared. *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. *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. *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).
PTHOWNFILE The file that owns the access path of the first
'based on' physical member. Blanks are returned if
the access path is not shared. This is an optional
return variable that if used must be specified as
*CHAR LEN(10).
PTHOWNLIB The library of the file that owns the access path of
the first 'based on' physical member. Blanks are
returned if the access path is not shared. This is
an optional return variable that if used must be
specified as *CHAR LEN(10).
PTHOWNMBR The member of the file that owns the access path of
the first 'based on' physical member. Blanks are
returned if the access path is not shared. This is
an optional return variable that if used must be
specified as *CHAR LEN(10).
CRTDATE The create date of the member. The value is
returned in the CYYMMDD format. This is an optional
return variable that if used must be specified as
*CHAR LEN(7).
CRTTIME The create time of the member. The value is
returned in the HHMMSS format. This is an optional
return variable that if used must be specified as
*CHAR LEN(6).
CHGDATE The last change date of the member. The value is
returned in the CYYMMDD format. This is an optional
return variable that if used must be specified as
*CHAR LEN(7).
CHGTIME The last change time of the member. The value is
returned in the HHMMSS format. This is an optional
return variable that if used must be specified as
*CHAR LEN(6).
LSTSRCCHGD The last source change date of the member if it
exists. The value is returned in the CYYMMDD
format. This is an optional return variable that if
used must be specified as *CHAR LEN(7).
LSTSRCCHGT The last source change time of the member if it
exists. The value is returned in the HHMMSS format.
This is an optional return variable that if used
must be specified as *CHAR LEN(6).
LSTUSEDATE The last used date of the member if it exists. The
value is returned in the CYYMMDD format. This is an
optional return variable that if used must be
specified as *CHAR LEN(7).
TEXT The text description of the member. This is an
optional return variable that if used must be
specified as *CHAR LEN(50).
Restrictions
------------
Because the command returns values, it may only be used in a CL
program.
Prerequisites
-------------
The following TAA Tools must be on your system:
CHKOBJ3 Check object 3
RSNLSTMSG Resend last message
RTVDBFA Retrieve data base file attributes
SNDESCINF Send escape information
SNDESCMSG Send escape message
Implementation
--------------
None, the tool is ready to use.
Objects used by the tool
------------------------
Object Type Attribute Src member Src file
------ ---- --------- ---------- ----------
RTVLFMD *CMD TAADBKP QATTCMD
TAADBKPC *PGM CLP TAADBKPC QATTCL
|
Added to TAA Productivity tools September 1, 2004
