The Retrieve Display File Attributes command may be used in a CL
program to retrieve most of the attributes for a Display file.
The command executes the DSPFD command using a file in QTEMP and then
returns the variables specified to the user program.
A typical use of the command is to test if the file uses 'restore
display' such as:
DCL &RSTDSP *CHAR LEN(4)
.
.
RTVDSPFA FILE(FILEX) RSTDSP(&RSTDSP)
IF (&RSTDSP *EQ '*YES') DO .....
The command parameters may be prompted for with the command. The
value in the parenthesis for each parameter describes the length and
type of field to be specified in your CL program to receive the
parameter.
Command parameters *CMD
------------------
FILE The qualified file name. The library defaults to
*LIBL.
RTNLIB An optional return variable that will contain the
library name where the display file was found. The
value may be helpful if the display file is accessed
without a specific library name. If specified, the
variable must be declared as *CHAR LEN(10).
WAITFILE An optional return variable that will contain the
Wait File time specified in the display file. The
value returned will be a number, *IMMED, or *CLS.
If specified, the variable must be declared as *CHAR
LEN(6).
WAITRCD An optional return variable that will contain the
Wait Record time specified in the display file. The
value returned will be a number, *IMMED, or *NOMAX.
If specified, the variable must be declared as *CHAR
LEN(6).
SHARE An optional return variable that will contain the
Shared Open value specified in the display file.
The value returned will be *YES or *NO. If
specified, the variable must be declared as *CHAR
LEN(4).
LVLCHK An optional return variable that will contain the
Level Check value specified in the display file.
The value returned will be *YES or *NO. If
specified, the variable must be declared as *CHAR
LEN(4).
DEV An optional return variable that will contain the
Device specified in the display file. If specified,
the variable must be declared as *CHAR LEN(10).
CRTDAT An optional return variable that will contain the
Create Date of the display file specified as YYMMDD.
If specified, the variable must be declared as *CHAR
LEN(6).
CRTTIM An optional return variable that will contain the
Create Time of the display file specified as HHMMSS.
If specified, the variable must be declared as *CHAR
LEN(6).
NBRFMTS An optional return variable that will contain the
Number of Formats in the display file. If
specified, the variable must be declared as *DEC
LEN(5 0).
RSTDSP An optional return variable that will contain the
Restore Display option of the display file. The
value returned will be *YES or *NO. If specified,
the variable must be declared as *CHAR LEN(4).
DFRWRT An optional return variable that will contain the
Defer Write option of the display file. The value
returned will be *YES or *NO. If specified, the
variable must be declared as *CHAR LEN(4).
FLDLVL An optional return variable that will contain a Y or
N indication as to whether the display file is
specified at the Field Level. If specified, the
variable must be declared as *CHAR LEN(1).
MAXDEV An optional return variable that will contain the
maximum number of devices specified for the display
file. If specified, the variable must be declared
as *DEC LEN(3 0).
DTAQ An optional return variable that will contain the
Data Queue specified for the display file. If
specified, the variable must be declared as *CHAR
LEN(10).
DTAQL An optional return variable that will contain the
library where the the Data Queue exists specified
for the display file. If specified, the variable
must be declared as *CHAR LEN(10).
GRPCHRSET An optional return variable that will contain the
Graphic Character Set specified for the display
file. If specified, the variable must be declared
as *CHAR LEN(10).
CODEPAGE An optional return variable that will contain the
Code Page specified for the display file. If
specified, the variable must be declared as *CHAR
LEN(10).
ENHDSP An optional return variable that will contain
whether the enhanced display attribute exists. A
*YES or *NO will be returned. If specified, the
variable must be declared as *CHAR LEN(4).
SFLENDTXT An optional return variable that will contain the
type of text to use for the SFLEND function. A *MSG
or *FILE value will be returned. If specified, the
variable must be declared as *CHAR LEN(5).
DECFMT An optional return variable that will contain the
type of decimal format to use. A *JOB or *FILE
value will be returned. If specified, the variable
must be declared as *CHAR LEN(5).
ALWPRT An optional return variable that will contain
whether the PRINT key is specified for the file. A
*YES or *NO value will be returned. If specified,
the variable must be declared as *CHAR LEN(4). This
attribute is not on the CRTDSPF command, but is a
DDS keyword.
SRTSEQ An optional return variable that will contain the
value specified on the CRTDSPF command for the
SRTSEQ parameter. If specified, the variable must
be declared as *CHAR LEN(10).
SRTSEQL An optional return variable that will contain the
value specified on the CRTDSPF command for the
qualified name of the SRTSEQ parameter. If
specified, the variable must be declared as *CHAR
LEN(10).
LANGID An optional return variable that will contain the
value specified on the CRTDSPF command for the
LANGID parameter. If specified, the variable must
be declared as *CHAR LEN(10).
CCSID An optional return variable that will contain the
Coded Character Set ID specified for the display
file. If specified, the variable must be declared
as *DEC LEN(5 0).
TEXT An optional return variable that will contain the
Text description specified for the display file. If
specified, the variable must be declared as *CHAR
LEN(50).
Prerequisites
-------------
None.
Implementation
--------------
None, the tool is ready to use.
Objects used by the tool
------------------------
Object Type Attribute Src member Src file
------ ----- --------- ---------- -----------
RTVDSPFA *CMD TAADSPA QATTCMD
TAADSPAC *PGM CLP TAADSPAC QATTCL
|
