Print Object Attributes
Table of Contents
- ID
- ATTR_AFP
- Type
- String
- Description
- Indicates whether this spooled file uses AFP resources external to
the spooled file. Valid values are *YES and *NO.
- ID
- ATTR_AFP_RESOURCE
- Type
- String
- Description
- The Integrated File System path of the external AFP (Advanced Function Print) resource.
The format of the Integrated File System path is "/QSYS.LIB/library.LIB/resource.type" where
library is the library that contains the resource, resource is
the name of the resource and type is the resource type. Valid values
for type include "FNTRSC", "FORMDF", "OVL", "PAGSEG", and "PAGDFN".
- ID
- ATTR_ALIGNFORMS
- Type
- String
- Description
- The time at which a forms alignment message will be sent. Valid values are *WTR, *FILE, *FIRST.
- ID
- ATTR_ALIGN
- Type
- String
- Description
- Indicates whether a forms alignment message is sent prior to printing
this spooled file. Valid values are *YES, *NO.
- ID
- ATTR_ALWDRTPRT
- Type
- String
- Description
- Indicates whether the printer writer allows the printer to be allocated
to a job that prints directly to a printer. Valid values are *YES, *NO.
- ID
- ATTR_AUT
- Type
- String
- Description
- Specifies the authority that is given to users who do not have specific
authority to the output queue. Valid values are *USE, *ALL, *CHANGE, *EXCLUDE,
*LIBCRTAUT.
- ID
- ATTR_AUTCHK
- Type
- String
- Description
- Indicates what type of authorities to the output queue allow the user
to control all the files on the output queue. Valid values are *OWNER,
*DTAAUT.
- ID
- ATTR_AUTOEND
- Type
- String
- Description
- Specifies if the writer should be automatically ended. Valid values
are *NO, *YES.
- ID
- ATTR_BACKMGN_ACR
- Type
- Float
- Description
- For the back side of a piece of paper, it specifies, how far in from
the left side of the page printing starts. The special value *FRONTMGN
will be encoded as -1.
- ID
- ATTR_BACKMGN_DWN
- Type
- Float
- Description
- For the back side of a piece of paper, it specifies, how far down from
the top of the page printing starts. The special value *FRONTMGN will be
encoded as -1.
- ID
- ATTR_BACK_OVERLAY
- Type
- String
- Description
- The Integrated File System path of the back overlay or a special value. If the value is an
Integrated File System path it will have the format "/QSYS.LIB/library.LIB/overlay.OVL" where
library is the library of the resource and overlay is the
name of the overlay.
Valid special values include *FRONTOVL.
- ID
- ATTR_BKOVL_ACR
- Type
- Float
- Description
- The offset across from the point of origin where the overlay is printed.
- ID
- ATTR_BKOVL_DWN
- Type
- Float
- Description
- The offset down from the point of origin where the overlay is printed.
- ID
- ATTR_BTWNCPYSTS
- Type
- String
- Description
- Whether or not the writer is between copies of a multiple copy spooled file. Returned
values are *YES or *NO.
- ID
- ATTR_BTWNFILESTS
- Type
- String
- Description
- Whether or not the writer is between files. Returned values are *YES or *NO.
- ID
- ATTR_CHANGES
- Type
- String
- Description
- The time at which pending changes take effect. Valid values are *NORDYF, *FILEEND, or blank which impilies no changes pending to the writer.
- ID
- ATTR_CPI
- Type
- Float
- Description
- The number of characters per horizontal inch.
- ID
- ATTR_CODEPAGE
- Type
- String
- Description
- The mapping of graphic characters to code points for this spooled file.
If the graphic character set field contains a special value, this field
may contain a zero (0).
- ID
- ATTR_CODEDFNT
- Type
- String
- Description
- The name of the coded font. A coded font is an AFP resource that is
composed of a character set and a code page. Special values include *FNTCHRSET.
- ID
- ATTR_CODEDFNTLIB
- Type
- String
- Description
- The name of the library that contains the coded font. This field may
contain blanks if the coded font name field has a special value.
- ID
- ATTR_CONTROLCHAR
- Type
- String
- Description
- Whether this file uses the American National Standards printer control character. The possible values are *NONE for no print control characters are passed in the data that is printed or *FCFC which means that the first character of every record is an American National Standards printer control character.
- ID
- ATTR_COPIES
- Type
- Integer
- Description
- The total number of copies to be produced for this spooled file.
- ID
- ATTR_COPIESLEFT
- Type
- Integer
- Description
- The remaining number of copies to be produced for this spooled file.
- ID
- ATTR_CURPAGE
- Type
- Integer
- Description
- Current page that is being written by the writer job.
- ID
- ATTR_DATAFORMAT
- Type
- String
- Description
- Data format. Valid values are *RCDDATA, *ALLDATA.
- ID
- ATTR_DATA_QUEUE
- Type
- String
- Description
- Specifies the Integrated File System path of the data queue that is associated with the output
queue or "*NONE" if no data queue is associated with the the output queue. The
format of the Integrated File System path is "/QSYS.LIB/library.LIB/dataqueue.DTAQ" where library
is the library that contains the data queue and dataqueue is the name of
the data queue.
- ID
- ATTR_DATE
- Type
- String
- Description
- For spooled files this is the date the spooled file was opened.
For AFP resources this is the date the object was last modified.
The date is encoded in a character
string with the following format, C YY MM DD.
- ID
- ATTR_DBCSDATA
- Type
- String
- Description
- Whether the spooled file contains double-byte character set (DBCS)
data. Valid values are *NO and *YES.
- ID
- ATTR_DBCSEXTENSN
- Type
- String
- Description
- Whether the system is to process the DBCS extension characters. Valid
values are *NO and *YES.
- ID
- ATTR_DBCAROTATE
- Type
- String
- Description
- Whether the DBCS characters are rotated 90 degrees counterclockwise
before printing. Valid values are *NO and *YES.
- ID
- ATTR_DBCSCPI
- Type
- Integer
- Description
- The number of double-byte characters to be printed per inch. Valid
values are -1, -2, 5, 6, and 10. The value *CPI is encoded as -1. The value
*CONDENSED is encoded as -2.
- ID
- ATTR_DBCSSISO
- Type
- String
- Description
- Determines the presentation of shift-out and shift-in characters when
printed. Valid values are *NO, *YES, and *RIGHT.
- ID
- ATTR_DFR_WRITE
- Type
- String
- Description
- Whether print data is held in system buffers before
- ID
- ATTR_PAGRTT
- Type
- Integer
- Description
- The degree of rotation of the text on the page, with respect to the
way the form is loaded into the printer. Valid values are -1, -2, -3, 0,
90, 180, 270. The value *AUTO is encoded as -1, the value *DEVD is encoded
as -2, and the value *COR is encoded as -3.
- ID
- ATTR_DELETESPLF
- Type
- String
- Description
- Delete the spooled file after sending? Valid values are *NO and *YES.
- ID
- ATTR_DESTOPTION
- Type
- String
- Description
- Destination option. A text string that allows the user to pass options
to the receiving system.
- ID
- ATTR_DESTINATION
- Type
- String
- Description
- Destination type. Valid values are *OTHER, *AS400, *PSF2.
- ID
- ATTR_DEVCLASS
- Type
- String
- Description
- The device class.
- ID
- ATTR_DEVMODEL
- Type
- String
- Description
- The model number of the device.
- ID
- ATTR_DEVSTATUS
- Type
- Integer
- Description
- The status of the printer device. Valid values are 0 (varied off), 10 (vary off pending), 20 (vary on pending), 30 (varied on), 40 (connect pending), 60 (active), 66 (active writer), 70 (held), 75 (powered off), 80 (recovery pending), 90 (recovery canceled), 100 (failed), 106 (failed writer), 110 (being serviced), 111 (damaged), 112 (locked), 113 (unknown).
- ID
- ATTR_DEVTYPE
- Type
- String
- Description
- The device type.
- ID
- ATTR_DISPLAYANY
- Type
- String
- Description
- Whether users who have authority to read this output queue can display
the output data of any output file on this queue or only the data in their
own files. Valid values are *YES, *NO, *OWNER.
- ID
- ATTR_DRWRSEP
- Type
- Integer
- Description
- Identifies the drawer from which the job and file separator pages are
to be taken. Valid values are -1, -2, 1, 2, 3. The value *FILE is encoded
as -1, and the value *DEVD is encoded as -2.
- ID
- ATTR_ENDPNDSTS
- Type
- String
- Description
- Whether an End Writer (ENDWTR) command has been issued for this writer. Possible
values are *NO - no ENDWTR command was issued, *IMMED - the writer ends as soon as its
output buffers are empty, *CTRLD - the writer ends after the current copy of the spooled
file has printed, *PAGEEND - the writer ends at the end of the page.
- ID
- ATTR_ENDPAGE
- Type
- Integer
- Description
- The page number at which to end printing the spooled file. Valid values
are 0 or the ending page number. The value *END is encoded as 0.
- ID
- ATTR_ENVLP_SOURCE
- Type
- String
- Description
- The size of the envelope in the envelope source. If this field
is not specified or the value is not valid, the special value of *MFRTYPMDL
is used. Valid values are *NONE - there is no envelope source,
*MFRTYPMDL - the envelope size suggested by the manufacturer type
and model is used, *MONARCH (3.875 x 7.5 inches), *NUMBER9 (3.875 x 8.875 inches),
*NUMBER10 (4.125 x 9.5 inches), *B5 (176mm x 250mm),
*C5 (162mm x 229mm), *DL (110mm x 220mm).
- ID
- ATTR_FILESEP
- Type
- Integer
- Description
- The number of file separator pages that are placed at the beginning
of each copy of the spooled file. Valid values are -1, or the number of
separators. The value *FILE is encoded as -1.
- ID
- ATTR_FOLDREC
- Type
- String
- Description
- Whether records that exceed the printer forms width are folded (wrapped)
to the next line. Valid values are *YES, *NO.
- ID
- ATTR_FONTID
- Type
- String
- Description
- The printer font that is used. Valid special values include *CPI and
*DEVD.
- ID
- ATTR_FORM_DEFINITION
- Type
- String
- Description
- The Integrated File System path name of the form definition or a special value.
If an Integrated File System path is specified the format is "/QSYS.LIB/library.LIB/formdef.FORMDF"
where library is the library of the form definition and
formdef is the name of the form definition.
Valid special values include *NONE, *INLINE, *INLINED, and *DEVD.
- ID
- ATTR_FORMFEED
- Type
- String
- Description
- The manner in which forms feed to the printer. Valid values are *CONT,
*CUT, *AUTOCUT, *DEVD.
- ID
- ATTR_FORMTYPE
- Type
- String
- Description
- The type of form to be loaded in the printer to print this spooled
file.
- ID
- ATTR_FORMTYPEMSG
- Type
- String
- Description
- Message option for sending a message to the writer's message queue
when the current form type is finished. Valid values are *MSG, *NOMSG,
*INFOMSG, *INQMSG.
- ID
- ATTR_FTMGN_ACR
- Type
- Float
- Description
- For the front side of a piece of paper, it specifies, how far in from
the left side of the page printing starts. The special value *DEVD is encoded
as -2.
- ID
- ATTR_FTMGN_DWN
- Type
- Float
- Description
- For the front side of a piece of paper, it specifies, how far down
from the top of the page printing starts. The special value *DEVD is encoded
as -2.
- ID
- ATTR_FRONT_OVERLAY
- Type
- String
- Description
- The Integrated File System path of the front overlay. The format of the Integrated File System path is
"/QSYS.LIB/library.LIB/overlay.OVL" where
library is the library of the resource and overlay is the
name of the overlay.
The string "*NONE" is used to indicate that no front overlay is specified.
- ID
- ATTR_FTOVL_ACR
- Type
- Float
- Description
- The offset across from the point of origin where the overlay is printed.
- ID
- ATTR_FTOVL_DWN
- Type
- Float
- Description
- The offset down from the point of origin where the overlay is printed.
- ID
- ATTR_CHAR_ID
- Type
- String
- Description
- The set of graphic characters to be used when printing this file. Valid
special values include *DEVD, *SYSVAL, and *JOBCCSID.
- ID
- ATTR_JUSTIFY
- Type
- Integer
- Description
- The percentage that the output is right justified. Valid values are
0, 50, 100.
- ID
- ATTR_HELDSTS
- Type
- String
- Description
- Whether the writer is held. Valid values are *YES, *NO.
- ID
- ATTR_HOLD
- Type
- String
- Description
- Whether the spooled file is held. Valid values are *YES, *NO.
- ID
- ATTR_HOLDPNDSTS
- Type
- String
- Description
- Whether a Hold Writer (HLDWTR) command has been issued for this writer. Possible values
are *NO - no HLDWTR command was issued, *IMMED - the writer is held when its output buffers
are empty, *CTRLD - writer held after the current copy of the spooled file has printed,
*PAGEEND - writer held at the end of the page.
- ID
- ATTR_WTRINIT
- Type
- String
- Description
- The user can specify when to initialize the printer device. Valid values
are *WTR, *FIRST, *ALL.
- ID
- ATTR_INTERNETADDR
- Type
- String
- Description
- The internet address of the receiving system.
- ID
- ATTR_JOBNAME
- Type
- String
- Description
- The name of the job that created the spooled file.
- ID
- ATTR_JOBNUMBER
- Type
- String
- Description
- The number of the job that created the spooled file.
- ID
- ATTR_JOBSEPRATR
- Type
- Integer
- Description
- The number of job separators to be placed at the beginning of the output
for each job having spooled files on this output queue. Valid values are
-2, 0-9. The value *MSG is encoded as -2. Job separators are specified
when the output queue is created.
- ID
- ATTR_JOBUSER
- Type
- String
- Description
- The name of the user that created the spooled file.
- ID
- ATTR_LASTPAGE
- Type
- Integer
- Description
- The number of the last printed page is the file if printing ended before
the job completed processing.
- ID
- ATTR_PAGELEN
- Type
- Float
- Description
- The length of a page. Units of measurement are specified in the measurement
method attribute.
- ID
- ATTR_LIBRARY
- Type
- String
- Description
- The name of the library.
- ID
- ATTR_LPI
- Type
- Float
- Description
- The number of lines per vertical inch in the spooled file.
- ID
- ATTR_LINESPACING
- Type
- String
- Description
- How a file's line data records are spaced when printed. The information is returned only for *LINE and *AFPDSLINE printer device types files. Valid values are *SINGLE, *DOUBLE, *TRIPLE, or *CTLCHAR.
- ID
- ATTR_MFGTYPE
- Type
- String
- Description
- Specifies the manufacturer, type, and model when transforming print
data from SCS to ASCII.
- ID
- ATTR_MAXRECORDS
- Type
- Integer
- Description
- The maximum number of records allowed in this file at the time this
file was opened. The value *NOMAX is encoded as 0.
- ID
- ATTR_MEASMETHOD
- Type
- String
- Description
- The measurement method that is used for the length of page and width
of page attributes. Valid values are *ROWCOL, *UOM.
- ID
- ATTR_MSGHELP
- Type
- char(*)
- Description
- The message help, which is sometimes known as second-level text, can
be returned by a "retrieve message" request. The system limits
the length to 3000 characters (English version must be 30 % less to allow
for translation).
- ID
- ATTR_MESSAGEID
- Type
- String
- Description
- The message ID.
- ID
- ATTR_MESSAGE_QUEUE
- Type
- String
- Description
- The Integrated File System path of the message queue that the writer uses for operational
messages. The format of the Integrated File System path is "/QSYS.LIB/library.LIB/messageque.MSGQ"
where library is the library that contains the message queue and
messageque is the name of the message queue.
- ID
- ATTR_MSGREPLY
- Type
- String
- Description
- The message reply. Text string to be provided by the client which answers
a message of type "inquiry". In the case of message retrieved,
the attribute value is returned by the server and contains the default
reply which the client can use. The system limits the length to 132 characters.
Should be null-terminated due to variable length.
- ID
- ATTR_MSGTEXT
- Type
- String
- Description
- The message text, that is sometimes known as first-level text, can
be returned by a "retrieve message" request. The system limits
the length to 132 characters.
- ID
- ATTR_MSGTYPE
- Type
- String
- Description
- The message type, a 2-digit, EBCDIC encoding. Two types of messages
indicate whether one can "answer" a "retrieved" message:
'04' Informational messages convey information without asking for a reply
(may require a corrective action instead), '05' Inquiry messages convey
information and ask for a reply.
- ID
- ATTR_MSGSEV
- Type
- Integer
- Description
- Message severity. Values range from 00 to 99. The higher the value,
the more severe or important the condition.
- ID
- ATTR_NETWORK
- Type
- String
- Description
- The network identifier of the system where the file was created.
- ID
- ATTR_NUMBYTES_SPLF
- Type
- Integer
- Description
- The total number of bytes available in the stream or spooled file.
The value indicates the number of bytes BEFORE any transform of the data takes place.
In order to accomodate files of sizes greater than 2**31 - 1 bytes, this value
is scaled; the user needs to multiply the value by 10K to get the actual number of bytes.
This attribute is not valid for spooled files being viewed in page-at-a-time mode.
- ID
- ATTR_NUMBYTES
- Type
- Integer
- Description
- The number of bytes to read for a read operation, or the number of
bytes to write for a write operation. The object action determines how
to interpret this attribute.
- ID
- ATTR_NUMFILES
- Type
- Integer
- Description
- The number of spooled files that exist on the output queue.
- ID
- ATTR_NUMWRITERS
- Type
- Integer
- Description
- The number of writer jobs started to the output queue.
- ID
- ATTR_OBJEXTATTR
- Type
- String
- Description
- An "extended" attribute used by some objects like font resources.
This value shows up via WRKOBJ and DSPOBJD commands on the AS/400. The
title on an AS/400 screen may just indicate "Attribute". In the
case of object types of font resources, for example, common values are
CDEPAG, CDEFNT, and FNTCHRSET.
- ID
- ATTR_ONJOBQSTS
- Type
- String
- Description
- Whether the writer is on a job queue and therefore is not currently
running. The possible values are *YES, *NO.
- ID
- ATTR_OPENCMDS
- Type
- String
- Description
- Specifies whether user wants SCS open time commands to be inserted
into datastream prior to spool file data. Valid values are *YES, *NO.
- ID
- ATTR_OPCNTRL
- Type
- String
- Description
- Whether users with job control authority are allowed to manage or control
the spooled files on this queue. Valid values are *YES, *NO.
- ID
- ATTR_ORDER
- Type
- String
- Description
- The order of spooled files on this output queue. Valid values are *FIFO,
*JOBNBR.
- ID
- ATTR_OUTPUTBIN
- Type
- Integer
- Description
- The output bin the printer uses for the printed output. Values range from 1 to 65535. The value *DEVD is encoded as 0.
- ID
- ATTR_OUTPTY
- Type
- String
- Description
- The priority of the spooled file. The priority ranges from 1 (highest)
to 9 (lowest). Valid values are 0-9, where 0 represents *JOB.
- ID
- ATTR_OUTPUT_QUEUE
- Type
- String
- Description
- The Integrated File System path of the output queue. The format of the Integrated File System path is
"/QSYS.LIB/library.LIB/queue.OUTQ" where library is the library
that contains the output queue and queue is the name of the
output queue.
- ID
- ATTR_OUTQSTS
- Type
- String
- Description
- The status of the output queue. Valid values are RELEASED, HELD.
- ID
- ATTR_OVERALLSTS
- Type
- Integer
- Description
- The overall status of the "logical printer". "Logical printer" refers to printer device, output queue and writer job. Valid values are 1 (unavailable), 2 (powered off or not yet available), 3 (stopped), 4 (message waiting), 5 (held), 6 (stop pending), 7 (hold pending), 8 (waiting for printer), 9 (waiting to start), 10 (printing), 11 (waiting for output queue), 12 (connect pending), 13 (powered off), 14 (unusable), 15 (being serviced), 999 (unknown).
- ID
- ATTR_OVERFLOW
- Type
- Integer
- Description
- The last line to be printed before the data that is being printed overflows
to the next page.
- ID
- ATTR_PAGE_AT_A_TIME
- Type
- String
- Description
- Specifies whether the spooled file is to be opened in page-at-a-time mode.
Valid values are *YES and *NO.
- ID
- ATTR_PAGES_EST
- Type
- String
- Description
- Specifies whether the page count is estimated rather than actual. Valid
values are *YES and *NO.
- ID
- ATTR_PAGENUMBER
- Type
- Integer
- Description
- The number of the page to be read from a spooled file opened in page-at-a-time mode.
- ID
- ATTR_MULTIUP
- Type
- Integer
- Description
- The number of logical pages that print on each side of each physical
page when the file is printed. Valid values are 1, 2, 4.
- ID
- ATTR_PAPER_SOURCE_1
- Type
- String
- Description
- The size of the paper in paper source one. If this field
is not specified or the value is not valid, the special value of *MFRTYPMDL
is used. Valid values are *NONE - there is no paper source one or the
paper is manually fed into the printer,
*MFRTYPMDL - the paper size suggested by the manufacturer type
and model is used, *LETTER (8.5 x 11.0 inches), *LEGAL (8.5 x 14.0 inches),
*EXECUTIVE (7.25 x 10.5 inches), *LEDGER (17.0 x 11.0 inches),
*A3 (297mm x 420mm), *A4 (210mm x 297mm), *A5 (148mm x 210mm),
*B4 (257mm x 364mm), *B5 (182mm x 257mm), *CONT80 (8.0 inches wide with
continuous form), *CONT132 (13.2 inches wide with continuous form).
- ID
- ATTR_PAPER_SOURCE_2
- Type
- String
- Description
- The size of the paper in paper source two. If this field
is not specified or the value is not valid, the special value of *MFRTYPMDL
is used. Valid values are *NONE - there is no paper source two or the
paper is manually fed into the printer,
*MFRTYPMDL - the paper size suggested by the manufacturer type
and model is used, *LETTER (8.5 x 11.0 inches), *LEGAL (8.5 x 14.0 inches),
*EXECUTIVE (7.25 x 10.5 inches), *LEDGER (17.0 x 11.0 inches),
*A3 (297mm x 420mm), *A4 (210mm x 297mm), *A5 (148mm x 210mm),
*B4 (257mm x 364mm), *B5 (182mm x 257mm), *CONT80 (8.0 inches wide with
continuous form), *CONT132 (13.2 inches wide with continuous form).
- ID
- ATTR_PELDENSITY
- Type
- String
- Description
- For font resources only, this value is an encoding of the number of
pels ("1" represents a pel size of 240, "2" represents
a pel size of 320). Additional values may become meaningful as the AS/400
system defines them.
- ID
- ATTR_POINTSIZE
- Type
- Float
- Description
- The point size in which this spooled file's text is printed. The special
value *NONE will be encoded as 0.
- ID
- ATTR_FIDELITY
- Type
- String
- Description
- The kind of error handling that is performed when printing. Valid values
are *ABSOLUTE, *CONTENT.
- ID
- ATTR_DUPLEX
- Type
- String
- Description
- How the information prints. Valid values are *FORMDF, *NO, *YES, *TUMBLE.
- ID
- ATTR_PRTQUALITY
- Type
- String
- Description
- The print quality that is used when printing this spooled file. Valid
values are *STD, *DRAFT, *NLQ, *FASTDRAFT.
- ID
- ATTR_PRTSEQUENCE
- Type
- String
- Description
- Print sequence. Valid values are *NEXT.
- ID
- ATTR_PRTTEXT
- Type
- String
- Description
- The text that is printed at the bottom of each page of printed output
and on separator pages. Valid special values include *BLANK and *JOB.
- ID
- ATTR_PRINTER
- Type
- String
- Description
- The name of the printer device.
- ID
- ATTR_PRTASSIGNED
- Type
- String
- Description
- Indicates if the printer is assigned. Valid values are 1 (assigned to a specific printer), 2 (assigned to multiple printers), 3 (not assigned).
- ID
- ATTR_PRTDEVTYPE
- Type
- String
- Description
- The printer data stream type. Valid values are *SCS, *IPDS, *USERASCII,
*AFPDS.
- ID
- ATTR_PRINTER_FILE
- Type
- String
- Description
- The Integrated File System path of the printer file. The format of the Integrated File System path is
"/QSYS.LIB/library.LIB/printerfile.FILE" where library is the library
that contains the printer file and printerfile is the name of
the printer file.
- ID
- ATTR_RMTPRTQ
- Type
- String
- Description
- The name of the destination printer queue when sending spooled files
via SNDTCPSPLF (LPR).
- ID
- ATTR_RECLENGTH
- Type
- Integer
- Description
- Record length.
- ID
- ATTR_REDUCE
- Type
- String
- Description
- The manner in which multiple logical pages print on each side of a physical page. Valid values *TEXT or ????.
- ID
- ATTR_RMTSYSTEM
- Type
- String
- Description
- Remote system name. Valid special values include *INTNETADR.
- ID
- ATTR_RPLUNPRT
- Type
- String
- Description
- Whether characters that cannot be printed are to be replaced with another
character. Valid values are *YES or *NO.
- ID
- ATTR_RPLCHAR
- Type
- String
- Description
- The character that replaces any unprintable characters.
- ID
- ATTR_RESTART
- Type
- Integer
- Description
- Restart printing. Valid values are -1, -2, -3, or the page number to
restart at. The value *STRPAGE is encoded as -1, the value *ENDPAGE is
encoded as -2, and the value *NEXT is encoded as -3.
- ID
- ATTR_SAVESPLF
- Type
- String
- Description
- Whether the spooled file is to be saved after it is written. Valid
values are *YES, *NO.
- ID
- ATTR_SEEKOFF
- Type
- Integer
- Description
- Seek offset. Allows both positive and negative values relative to the
seek origin.
- ID
- ATTR_SEEKORG
- Type
- Integer
- Description
- Valid values include 1 (beginning or top), 2 (current), and 3 (end
or bottom).
- ID
- ATTR_SENDPTY
- Type
- String
- Description
- Send priority. Valid values are *NORMAL, *HIGH.
- ID
- ATTR_SEPPAGE
- Type
- String
- Description
- Allows a user the option of printing a banner page or not. Valid values
are *YES or *NO.
- ID
- ATTR_SRCDRWR
- Type
- Integer
- Description
- The drawer to be used when the automatic cut sheet feed option is selected.
Valid values are -1, -2, 1-255. The value *E1 is encode as -1, and the
value *FORMDF is encoded as -2.
- ID
- ATTR_SPLSCS
- Type
- Long
- Description
- Determines how SCS data is used during create spool file. Valid values
are -1, 0, 1, or the page number. The value *ENDPAGE is encoded as -1.
For the value 0, printing starts on page 1. For the value 1, the entire
file prints.
- ID
- ATTR_SPOOL
- Type
- String
- Description
- Whether the output data for the printer device is spooled. Valid values
are *YES, *NO.
- ID
- ATTR_SPOOLFILE
- Type
- String
- Description
- The name of the spooled file.
- ID
- ATTR_SPLFNUM
- Type
- Integer
- Description
- The spooled file number.
- ID
- ATTR_SPLFSTATUS
- Type
- String
- Description
- The status of the spooled file. Valid values are *CLOSED, *HELD, *MESSAGE,
*OPEN, *PENDING, *PRINTER, *READY, *SAVED, *WRITING.
- ID
- ATTR_SCHEDULE
- Type
- String
- Description
- Specifies, for spooled files only, when the spooled file is available
to the writer. Valid values are *IMMED, *FILEEND, *JOBEND.
- ID
- ATTR_STARTEDBY
- Type
- String
- Description
- The name of the user who started the writer.
- ID
- ATTR_STARTPAGE
- Type
- Integer
- Description
- The page number at which to start printing the spooled file. Valid
values are -1, 0, 1, or the page number. The value *ENDPAGE is encoded
as -1. For the value 0, printing starts on page 1. For the value 1, the
entire file prints.
- ID
- ATTR_SYSTEM
- Type
- String
- Description
- The name of the system where the spooled file was created. When the name of the system where this spooled file was created cannot be determined, the receiving system name is used.
- ID
- ATTR_DESCRIPTION
- Type
- String
- Description
- Text to describe an instance of an AS/400 object.
- ID
- ATTR_TIMEOPEN
- Type
- String
- Description
- For spooled files this is the time this spooled file was opened.
For AFP resources this is the time the object was last modified.
The time is encoded in a character string with the following format,
HH MM SS.
- ID
- ATTR_PAGES
- Type
- Integer
- Description
- The number of pages that are contained in a spooled file.
- ID
- ATTR_SCS2ASCII
- Type
- String
- Description
- Whether the print data is to be transformed from SCS to ASCII. Valid
values are *YES, *NO.
- ID
- ATTR_UNITOFMEAS
- Type
- String
- Description
- The unit of measure to use for specifying distances. Valid values are
*CM, *INCH.
- ID
- ATTR_USERCMT
- Type
- String
- Description
- The 100 characters of user-specified comment that describe the spooled
file.
- ID
- ATTR_USERDATA
- Type
- String
- Description
- The 10 characters of user-specified data that describe the spooled
file. Valid special values include *SOURCE.
- ID
- ATTR_USRDFNDTA
- Type
- String
- Description
- User defined data to be utilized by user applications or user specified
programs that process spool files. All characters are acceptable. Max size
is 255.
- ID
- ATTR_USRDEFFILE
- Type
- String
- Description
- Whether the spooled file was created using an API. Valid values are *YES, or *NO.
- ID
- ATTR_USER_DEFINED_OBJECT
- Type
- String
- Description
- The Integrated File System path of the user defined object to be utilized
by user applications that process spool files. If an Integrated File System path the format
of the Integrated File System path is "/QSYS.LIB/library.LIB/object.type" where library
is the name of the library that contains the object or one of the special
values %LIBL% or %CURLIB%. object is the name of the object and
type is the object type. Valid values for type include
"DTAARA", "DTAQ", "FILE", "PSFCFG", "USRIDX", "USRQ" and "USRSPC".
The string "*NONE" is used to indicate no user defined object is to
be used.
- ID
- ATTR_USEDFNOPTS
- Type
- String
- Description
- User defined options to be utilized by user applications that process
spool files. Up to 4 options may be specifies, each value is length char(10).
All characters are acceptable.
- ID
- ATTR_USRDRVPGMDTA
- Type
- String
- Description
- User data to be used with the user driver program. All characters are
acceptable. Maximum size is 5000 characters.
- ID
- ATTR_USER_DRIVER_PROG
- Type
- String
- Description
- The Integrated File System path of the user defined driver progam that processes spooled files.
The format of the Integrated File System path is "/QSYS.LIB/library.LIB/program.PGM" where
library is the name of the library that contains the program and
program is the program name. The library may be one of the
special values %LIBL% and %CURLIB% or a specific library name.
The string "*NONE" is used to indicate that no driver program is defined.
- ID
- ATTR_TOUSERID
- Type
- String
- Description
- User id to whom the spooled file is sent.
- ID
- ATTR_TOADDRESS
- Type
- String
- Description
- Address of user to whom the spooled file is sent.
- ID
- ATTR_USER_TRANSFORM_PROG
- Type
- String
- Description
- The Integrated File System path of the user defined transform program that
transforms spool file data before it is processed by the driver program.
The format of the Integrated File System path is "/QSYS.LIB/library.LIB/program.PGM" where
library is the name of the library that contains the program and
program is the program name. The library may be one of the
special values %LIBL% and %CURLIB% or a specific library name.
The string "*NONE" is used to indicate that no transform program is defined.
- ID
- ATTR_VIEWING_FIDELITY
- Type
- String
- Description
- The processing to take place when viewing a page of
spooled file data (in page-at-a-time mode).
Valid values are *ABSOLUTE and *CONTENT(default). To process all non-raster data (commands) prior
to the current page, *ABSOLUTE is used. For SCS files, *CONTENT is used to process
only open time commands plus the current page. For AFPDS files, *CONTENT
is used to process the first page of data plus the current page.
- ID
- ATTR_VMMVSCLASS
- Type
- String
- Description
- VM/MVS class. Valid values are A-Z and 0-9.
- ID
- ATTR_WTRAUTOEND
- Type
- String
- Description
- When to end the writer if it is to be ended automatically. Valid values
are *NORDYF, *FILEEND. Attribute Automatically end writer must be set to
*YES.
- ID
- ATTR_WTNGDATASTS
- Type
- String
- Description
- Whether the writer has written all the data currently in the spooled file
and is waiting for more data. Possible values are *NO - the writer is not
waiting for more data, *YES - the writer has written all the data currently in
the spooled file and is waiting for more data. This condition occurs when the
writer is producing an open spooled file with SCHEDULE(*IMMED) specified.
- ID
- ATTR_WTNGDEVSTS
- Type
- String
- Description
- Whether the writer is waiting to get the device from a job that is printing
directly to the printer. Values are *NO - the writer is not waiting for the
device, *YES - the writer is waiting for the device.
- ID
- ATTR_WTNGMSGSTS
- Type
- String
- Description
- Whether the writer is waiting for a reply to an inquiry message. Values are
*NO and *YES.
- ID
- ATTR_WTREND
- Type
- String
- Description
- When to end the writer. Valid value are *CNTRLD, *IMMED, and *PAGEEND.
This is different from when to automatically end the writer.
- ID
- ATTR_HOLDTYPE
- Type
- String
- Description
- When to hold the spooled file. Valid values are *IMMED, and *PAGEEND.
- ID
- ATTR_PAGEWIDTH
- Type
- Float
- Description
- The width of a page. Units of measurement are specified in the measurement
method attribute.
- ID
- ATTR_WORKSTATION_CUST_OBJECT
- Type
- String
- Description
- The Integrated File System path of the workstation customizing object. The format of the Integrated File System path
is "/QSYS.LIB/library.LIB/custobj.WSCST" where library is the library that
contains the customization object and custobj is the name of the workstation
customization object.
- ID
- ATTR_WRITER
- Type
- String
- Description
- The name of the writer job.
- ID
- ATTR_WTRJOBNUM
- Type
- String
- Description
- The writer job number.
- ID
- ATTR_WTRJOBSTS
- Type
- String
- Description
- The status of the writer job. Valid values are STR, END, JOBQ, HLD,
MSGW.
- ID
- ATTR_WTRJOBUSER
- Type
- String
- Description
- The name of the user that started the writer job.
- ID
- ATTR_WTRSTRTD
- Type
- String
- Description
- Indicates whether or not a writer is started for this printer. Values
are 1 - yes a writer is started, 0 - no writer is started.
- ID
- ATTR_WTRSTRPAGE
- Type
- Integer
- Description
- Specifies the page number of the first page to print from the first
spooled file when the writer job starts. This is only valid if the spooled
file name is also specified when the writer starts.
- ID
- ATTR_WRTNGSTS
- Type
- String
- Description
- Indicates whether the print writer is in writing status. Values are
*YES - the writer is in writing status, *NO - the writer is not in writing
status, *FILE - the writer is writing the file separators.
- ID
- ATTR_NPSCCSID
- Type
- Integer
- Description
- CCSID that the Network Print Server expects that all strings will be
encoded in.
- ID
- ATTR_NPSLEVEL
- Description
- The version, release, and modification level of the Network Print Server.
This attribute is a character string encoded as VXRYMY (ie. "V3R1M0")
where
X is in (0..9)
Y is in (0..9,A..Z)