The RTVPRTFA command may be used in a CL program
to access most of a printer device file's attributes.
The spooling attributes can be retrieved using the
RTVSPLA TAA Tool command.
A typical use of the command is to test if the file is an IPDS type
such as:
DCL &DEVTYPE *CHAR LEN(10)
.
.
RTVPRTFA FILE(FILEX) DEVTYPE(&DEVTYPE)
IF (&DEVTYPE *EQ '*IPDS') 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.
Because more than the maximum of 40 parameters exist that could be
returned, a second command RTVPRTFA2 exists to return additional
parameters.
RTVPRTFA 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 printer device file was
found. The value may be helpful if the printer 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 file. 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 file. A value of
*YES or *NO will be returned. 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 file. A value of
*YES or *NO will be returned. If specified, the
variable must be declared as *CHAR LEN(4).
CRTDAT An optional return variable that will contain the
create date of the file. The value will be returned
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 file. The value will be returned
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 file. If specified, the
variable must be declared as *DEC LEN(5 0).
FLDLVL An optional return variable that will contain a Y or
N as to whether the file is defined to the field
level. If specified, the variable must be declared
as *CHAR LEN(1).
DEV An optional return variable that will contain the
device name in the file. If specified, the variable
must be declared as *CHAR LEN(10).
MAXDEV An optional return variable that will contain the
maximum number of devices in the file. If
specified, the variable must be declared as *DEC
LEN(3 0).
SPOOL An optional return variable that will contain a *YES
or *NO for whether the file is to be spooled. If
specified, the variable must be declared as *CHAR
LEN(4).
FOLD An optional return variable that will contain a *YES
or *NO for whether a print line that exceeds the
print width should be folded. If specified, the
variable must be declared as *CHAR LEN(4).
RPLUNPRT An optional return variable that will contain a *YES
or *NO for whether an unprintable character should
be replaced. If specified, the variable must be
declared as *CHAR LEN(4).
RPLUNPRTC An optional return variable that will contain the
character to replace an unprintable character if
RPLUNPRT(*YES) is specified. If specified, the
variable must be declared as *CHAR LEN(2).
CPI An optional return variable that will contain the
characters per inch specified for the file. If
specified, the variable must be declared as *DEC
LEN(3 1).
LPI An optional return variable that will contain the
lines per inch specified for the file. If
specified, the variable must be declared as *DEC
LEN(3 1).
ALIGN An optional return variable that will contain a *YES
or *NO for whether to perform forms alignment when
printing the file. If specified, the variable must
be declared as *CHAR LEN(4).
DEVTYPE An optional return variable that will contain the
device type of the file. The value to be returned
will be *SCS, *IPDS, *USERASCII, or *AFPDS. If
specified, the variable must be declared as *CHAR
LEN(10).
PAGLEN An optional return variable that will contain the
page length of the file. If specified, the variable
must be declared as *DEC LEN(3 0).
PAGWTH An optional return variable that will contain the
page width of the file. If specified, the variable
must be declared as *DEC LEN(3 0).
OVERFLOW An optional return variable that will contain the
overflow line of the file. If specified, the
variable must be declared as *DEC LEN(3 0).
PAGRTT An optional return variable that will contain the
page rotation specified for the file. The value
returned will be *AUTO, *DEVD, *COR, 0, 90, 180, or
270. If specified, the variable must be declared as
*CHAR LEN(5).
PRTTXT An optional return variable that will contain the
print text specified for the file. If specified,
the variable must be declared as *CHAR LEN(30).
JUSTIFY An optional return variable that will contain the
right justification for the file. A value of 0, 50,
or 100 will be returned. If specified, the variable
must be declared as *CHAR LEN(3).
CTLCHAR An optional return variable that will contain the
control character to be used for the file. The
value returned will be *NONE or *FCFC. If
specified, the variable must be declared as *CHAR
LEN(5).
PRTQLTY An optional return variable that will contain the
print quality value used for the file. The value
returned will be *STD, *DEVD, *DRAFT, *NLQ, or
*FASTDRAFT. If specified, the variable must be
declared as *CHAR LEN(6).
FORMFEED An optional return variable that will contain the
form feed value used for the file. The value
returned will be *DEVD, *AUTOCUT, *CONT, or *CUT.
If specified, the variable must be declared as *CHAR
LEN(8).
DRAWER An optional return variable that will contain the
source Drawer used for the file. The value returned
will be 1-255, or *E1. If specified, the variable
must be declared as *CHAR LEN(8).
FONT An optional return variable that will contain the
printer font used for the file. If specified, the
variable must be declared as *CHAR LEN(10).
GRPCHRSET An optional return variable that will contain the
Graphic Character Set used for the file. The value
returned will be *DEVD, *SYSVAL, or *JOBCCSID. If
specified, the variable must be declared as *CHAR
LEN(10).
CODEPAGE An optional return variable that will contain the
Code page used for the file. If specified, the
variable must be declared as *CHAR LEN(10).
DUPLEX An optional return variable that will contain the
value for the Duplex parameter of the file. If
specified, the variable must be declared as *CHAR
LEN(7).
MULTIUP An optional return variable that will contain the
multi-up value (pages per side) of the file. If
specified, the variable must be declared as *DEC
LEN(2 0).
UOM An optional return variable that will contain the
Unit of Measure value used for the file. The value
returned will be *INCH or *CM. If specified, the
variable must be declared as *CHAR LEN(5).
DECFMT An optional return variable that will contain the
decimal format used. The value returned will be
*JOB or *FILE. If specified, the variable must be
declared as *CHAR LEN(5).
REDUCE An optional return variable that will contain the
type of print reduction. The value returned will be
*TEXT or *NONE. If specified, the variable must be
declared as *CHAR LEN(5).
TBLREFCHR An optional return variable that will contain
whether Table Reference Characters are present in
the line data. The value returned will be *YES or
*NO. If specified, the variable must be declared as
*CHAR LEN(4).
CCSID An optional return variable that will contain the
Coded Character Set ID for the file. If specified,
the variable must be declared as *DEC LEN(5 0).
TEXT An optional return variable that will contain the
Text description used for the file. If specified,
the variable must be declared as *CHAR LEN(50).
RTVPRTFA2 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 printer device file was
found. The value may be helpful if the printer file
is accessed without a specific library name. If
specified, the variable must be declared as *CHAR
LEN(10).
FIDELITY An optional return variable that will contain the
Fidelity attribute. Either *CONTENT or *ABSOLUTE
will be returned. If specified, the variable must
be declared as *CHAR LEN(10).
OUTBIN An optional return variable that will contain the
Output bin. Either *DEVD or a number will be
returned. If specified, the variable must be
declared as *CHAR LEN(10).
Restrictions
------------
Spool attributes contained the printer file may be accessed by the
RTVSPLA TAA tool.
The following parameter is not supported:
CHLVAL
Prerequisites
-------------
The following TAA Tools must be on your system:
EDTVAR Edit variable
SNDESCMSG Send escape message
Implementation
--------------
None, the tool is ready to use.
Objects used by the tool
------------------------
Object Type Attribute Src member Src file
------ ----- --------- ---------- -----------
RTVPRTFA *CMD TAAPRTA QATTCMD
RTVPRTFA2 *CMD TAAPRTA2 QATTCMD
TAAPRTAC *PGM CLP TAAPRTAC QATTCL
TAAPRTAC2 *PGM CLP TAAPRTAC2 QATTCL
|
