Print Object Attributes


Table of Contents

  • Advanced Function Printing
  • AFP Resource
  • Align Forms
  • Align Page
  • Allow Direct Print
  • Authority
  • Authority to Check
  • Automatically End Writer
  • Back Margin Offset Across
  • Back Margin Offset Down
  • Backside Overlay
  • Back Overlay offset across
  • Back Overlay Offset Down
  • Between Copies Status
  • Between Files Status
  • Changes
  • Characters per Inch
  • Code Page
  • Code Font Name
  • Coded Font Library Name
  • Control Character
  • Convert line data
  • Copies
  • Copies left to Produce
  • Corner staple
  • Current Page
  • Data Format
  • Data Queue
  • Date File Opened
  • Date Writer Began Processing Spooled File
  • Date Writer Completed Procesing Spooled File
  • User Specified DBCS Data
  • DBCS Extension Characters
  • DBCS Character Rotation
  • DBCS Characters per Inch
  • DBCS SO/SI Spacing
  • Defer Write
  • Degree of Page Rotation
  • Delete File After Sending
  • Destination Option
  • Destination Type
  • Device Class
  • Device Model
  • Device Status
  • Device Type
  • Display any File
  • Drawer for Separators
  • Edge Stitch Number of Staples
  • Edge Stitch Reference
  • Edge Stitch Reference Offset
  • End Pending Status
  • Ending Page
  • Envelope Source
  • File Separators
  • Fold Records
  • Font Identifier
  • Form Definition
  • Form Feed
  • Form Type
  • Form Type Message Option
  • Front Margin Offset Across
  • Front Margin Offset Down
  • Front Overlay
  • Front Overlay Offset Across
  • Front Overlay Offset Down
  • Graphic Character Set
  • Hardware Justification
  • Held Status
  • Hold Spool File
  • Hold Pending Status
  • Initialize the writer
  • Internet Address
  • IPP Attributes-charset
  • IPP Job ID
  • IPP Job Name
  • IPP Job Name NL
  • IPP Job Originating User Name
  • IPP Job Originating User Name NL
  • IPP IPP Printer Name
  • Job Name
  • Job Number
  • Job Separators
  • Job User
  • Last Page Printed
  • Length of Page
  • Library Name
  • Lines Per Inch
  • Line Spacing
  • Manufacturer Type and Model
  • Max Jobs per Client List
  • Maximum Spooled Output Records
  • Measurement Method
  • Message Help
  • Message ID
  • Message Queue
  • Message Reply
  • Message Text
  • Message Type
  • Message Severity
  • Multi_Item Reply Capability
  • Network Identifier
  • Number of Bytes in Spooled File
  • Number of Bytes to Read/Write
  • Number of Files
  • Number of Writers Started to Queue
  • Object Extended Attribute
  • On Job Queue Status
  • Open time commands
  • Operator Controlled
  • Order of Files On Queue
  • Output Bin
  • Output Priority
  • Output Queue
  • Output Queue Status
  • Overall Status
  • Overflow Line Number
  • Page At A Time
  • Page Count Estimated
  • Page Defintion
  • Page Number
  • Pages Per Side
  • Paper Source 1
  • Paper Source 2
  • Pel Density
  • Point Size
  • Print Fidelity
  • Print on Both Sides
  • Print Quality
  • Print Sequence
  • Print Text
  • Printer
  • Printer Assigned
  • Printer Device Type
  • Printer File
  • Printer Queue
  • Record Length
  • Reduce Output
  • Remote System
  • Replace Unprintable Characters
  • Replacement Character
  • Restart Printing
  • Save Spooled File
  • Saddle Stitch Number of Staples
  • Saddle Stitch Reference
  • Seek Offset
  • Seek Origin
  • Send Priority
  • Separator page
  • Source Drawer
  • Spool SCS
  • Spool the Data
  • Spooled File Creation Authentication Method
  • Spooled File Creation Security Method
  • Spooled File Name
  • Spooled File Number
  • Spooled File Status
  • Spooled Output Schedule
  • Started By User
  • Starting Page
  • System Where Created
  • Text Description
  • Time File Opened
  • Time Writer Began Processing Spooled File
  • Time Writer Completed Procesing Spooled File
  • Total Pages
  • Transform SCS to ASCII
  • Unit of Measure
  • User Comment
  • User Data
  • User Defined Data
  • User Defined File
  • User Defined Object
  • User Defined Option(s)
  • User Driver Program Data
  • User Driver Program
  • User ID
  • User ID Address
  • User Transform Program
  • Viewing Fidelity
  • VM/MVS Class
  • Waiting for Data Status
  • Waiting for Device Status
  • Waiting for Message Status
  • When to Automatically End Writer
  • When to End Writer
  • When to Hold File
  • Width of Page
  • Workstation Customizing Object
  • Writer Job Name
  • Writer Job Number
  • Writer Job Status
  • Writer Job User Name
  • Writer Started
  • Writer Starting Page
  • Writing Status
  • Network Print Server Object Attributes
  • NPS CCSID
  • NPS Level

  • Advanced Function Printing

    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.


    AFP Resource

    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".


    Align Forms

    ID
    ATTR_ALIGNFORMS
    Type
    String
    Description
    The time at which a forms alignment message will be sent. Valid values are *WTR, *FILE, *FIRST.


    Align Page

    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.


    Allow Direct Print

    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.


    Authority

    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.


    Authority to Check

    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.


    Automatically End Writer

    ID
    ATTR_AUTOEND
    Type
    String
    Description
    Specifies if the writer should be automatically ended. Valid values are *NO, *YES.


    Back Margin Offset Across

    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.


    Back Margin Offset Down

    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.


    Back Overlay

    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.


    Back Overlay offset across

    ID
    ATTR_BKOVL_ACR
    Type
    Float
    Description
    The offset across from the point of origin where the overlay is printed.


    Back Overlay Offset Down

    ID
    ATTR_BKOVL_DWN
    Type
    Float
    Description
    The offset down from the point of origin where the overlay is printed.


    Between Copies Status

    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.


    Between Files Status

    ID
    ATTR_BTWNFILESTS
    Type
    String
    Description
    Whether or not the writer is between files. Returned values are *YES or *NO.


    Changes

    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.


    Characters per Inch

    ID
    ATTR_CPI
    Type
    Float
    Description
    The number of characters per horizontal inch.


    Code Page

    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).


    Code Font Name

    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.


    Coded Font Library Name

    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.


    Control Character

    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.


    Convert Line Data

    ID
    ATTR_CONVERT_LINEDATA
    Type
    String
    Description
    Whether the line data is converted to AFPDS before it is written to spool. The possible values are *NO and *YES.


    Copies

    ID
    ATTR_COPIES
    Type
    Integer
    Description
    The total number of copies to be produced for this spooled file.


    Copies left to Produce

    ID
    ATTR_COPIESLEFT
    Type
    Integer
    Description
    The remaining number of copies to be produced for this spooled file.


    Corner Staple

    ID
    ATTR_CORNER_STAPLE
    Type
    String
    Description
    The reference corner to be used for a corner staple. A staple is driven into the media at the reference corner. Valid values are *NONE, *DEVD, *BOTRIGHT, *TOPRIGHT, *TOPLEFT, and *BOTLEFT.


    Current Page

    ID
    ATTR_CURPAGE
    Type
    Integer
    Description
    Current page that is being written by the writer job.


    Data Format

    ID
    ATTR_DATAFORMAT
    Type
    String
    Description
    Data format. Valid values are *RCDDATA, *ALLDATA.


    Data Queue

    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.


    Date File Opened

    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.


    Date Writer Began Processsing Spooled File

    ID
    ATTR_DATE_WTR_BEGAN_FILE
    Type
    String
    Description
    Indicates the date at which the writer began processing this spooled file. The date is encoded in a character string with the following format, C YY MM DD.


    Date Writer Completed Processsing Spooled File

    ID
    ATTR_DATE_WTR_CMPL_FILE
    Type
    String
    Description
    Indicates the date at which the writer began finished this spooled file. The date is encoded in a character string with the following format, C YY MM DD.


    User Specified DBCS Data

    ID
    ATTR_DBCSDATA
    Type
    String
    Description
    Whether the spooled file contains double-byte character set (DBCS) data. Valid values are *NO and *YES.


    DBCS Extension Characters

    ID
    ATTR_DBCSEXTENSN
    Type
    String
    Description
    Whether the system is to process the DBCS extension characters. Valid values are *NO and *YES.


    DBCS Character Rotation

    ID
    ATTR_DBCAROTATE
    Type
    String
    Description
    Whether the DBCS characters are rotated 90 degrees counterclockwise before printing. Valid values are *NO and *YES.


    DBCS Characters per Inch

    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.


    DBCS SO/SI Spacing

    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.


    Defer Write

    ID
    ATTR_DFR_WRITE
    Type
    String
    Description
    Whether print data is held in system buffers before


    Degree of Page Rotation

    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.


    Delete File After Sending

    ID
    ATTR_DELETESPLF
    Type
    String
    Description
    Delete the spooled file after sending? Valid values are *NO and *YES.


    Destination Option

    ID
    ATTR_DESTOPTION
    Type
    String
    Description
    Destination option. A text string that allows the user to pass options to the receiving system.


    Destination Type

    ID
    ATTR_DESTINATION
    Type
    String
    Description
    Destination type. Valid values are *OTHER, *AS400, *PSF2.


    Device Class

    ID
    ATTR_DEVCLASS
    Type
    String
    Description
    The device class.


    Device Model

    ID
    ATTR_DEVMODEL
    Type
    String
    Description
    The model number of the device.


    Device Status

    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).


    Device Type

    ID
    ATTR_DEVTYPE
    Type
    String
    Description
    The device type.


    Display any File

    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.


    Drawer for Separators

    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.


    Edge Stitch Number of Staples

    ID
    ATTR_EDGESTITCH_NUMSTAPLES
    Type
    Integer
    Description
    The number of staples that are applied along the finishing operation axis.


    Edge Stitch Reference

    ID
    ATTR_EDGESTITCH_REF
    Type
    String
    Description
    Where one or more staples are driven into the media along the finishing operation axis. Valid values are *NONE, *DEVD, *BOTTOM, *RIGHT, *TOP, and *LEFT.


    Edge Stitch Reference Offset

    ID
    ATTR_EDGESTITCH_REFOFF
    Type
    Float
    Description
    The offset of the edge stitch from the reference edge toward the center of the media.


    End Pending Status

    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.


    Ending 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.


    Envelope Source

    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).


    File Separators

    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.


    Fold Records

    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.


    Font Identifier

    ID
    ATTR_FONTID
    Type
    String
    Description
    The printer font that is used. Valid special values include *CPI and *DEVD.


    Form Definition

    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.


    Form Feed

    ID
    ATTR_FORMFEED
    Type
    String
    Description
    The manner in which forms feed to the printer. Valid values are *CONT, *CUT, *AUTOCUT, *DEVD.


    Form Type

    ID
    ATTR_FORMTYPE
    Type
    String
    Description
    The type of form to be loaded in the printer to print this spooled file.


    Form Type Message Option

    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.


    Front Margin Offset Across

    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.


    Front Margin Offset Down

    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.


    Front Overlay

    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.


    Front Overlay Offset Across

    ID
    ATTR_FTOVL_ACR
    Type
    Float
    Description
    The offset across from the point of origin where the overlay is printed.


    Front Overlay Offset Down

    ID
    ATTR_FTOVL_DWN
    Type
    Float
    Description
    The offset down from the point of origin where the overlay is printed.


    Graphic Character Set

    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.


    Hardware Justification

    ID
    ATTR_JUSTIFY
    Type
    Integer
    Description
    The percentage that the output is right justified. Valid values are 0, 50, 100.


    Held Status

    ID
    ATTR_HELDSTS
    Type
    String
    Description
    Whether the writer is held. Valid values are *YES, *NO.


    Hold Spool File

    ID
    ATTR_HOLD
    Type
    String
    Description
    Whether the spooled file is held. Valid values are *YES, *NO.


    Hold Pending Status

    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.


    Initialize the writer

    ID
    ATTR_WTRINIT
    Type
    String
    Description
    The user can specify when to initialize the printer device. Valid values are *WTR, *FIRST, *ALL.


    Internet Address

    ID
    ATTR_INTERNETADDR
    Type
    String
    Description
    The internet address of the receiving system.


    IPP Attributes-charset

    ID
    ATTR_IPP_ATTR_CHARSET
    Type
    String
    Description
    Indicates the charset (coded character set and encoding method) of the IPP specified spooled file attributes.


    IPP Job ID

    ID
    ATTR_IPP_JOB_ID
    Type
    Integer
    Description
    IPP Job ID relative to the IPP printer that created the job.


    IPP Job Name

    ID
    ATTR_IPP_ATR_CHARSET
    Type
    String
    Description
    User friendly name of job.


    IPP Job Name NL

    ID
    ATTR_IPP_JOB_NAME_NL
    Type
    String
    Description
    Natural language of job name.


    IPP Job Originating User Name

    ID
    ATTR_IPP_JOB_ORIGUSER
    Type
    String
    Description
    Identifies the end user that submitted this IPP job.


    IPP Job Originating User Name NL

    ID
    ATTR_IPP_JOB_ORIGUSER_NL
    Type
    String
    Description
    Identifies the natural language of job-originating user name.


    IPP Printer Name

    ID
    ATTR_IPP_PRINTER_NAME
    Type
    String
    Description
    Identifies the IPP printer that created this job.


    Job Name

    ID
    ATTR_JOBNAME
    Type
    String
    Description
    The name of the job that created the spooled file.


    Job Number

    ID
    ATTR_JOBNUMBER
    Type
    String
    Description
    The number of the job that created the spooled file.


    Job Separators

    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.


    Job User

    ID
    ATTR_JOBUSER
    Type
    String
    Description
    The name of the user that created the spooled file.


    Last Page Printed

    ID
    ATTR_LASTPAGE
    Type
    Integer
    Description
    The number of the last printed page is the file if printing ended before the job completed processing.


    Length of Page

    ID
    ATTR_PAGELEN
    Type
    Float
    Description
    The length of a page. Units of measurement are specified in the measurement method attribute.


    Library Name

    ID
    ATTR_LIBRARY
    Type
    String
    Description
    The name of the library.


    Lines Per Inch

    ID
    ATTR_LPI
    Type
    Float
    Description
    The number of lines per vertical inch in the spooled file.


    Line Spacing

    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.


    Manufacturer Type and Model

    ID
    ATTR_MFGTYPE
    Type
    String
    Description
    Specifies the manufacturer, type, and model when transforming print data from SCS to ASCII.


    Maximum Jobs per Client List

    ID
    ATTR_MAX_JOBS_PER_CLIENT
    Type
    Integer
    Description
    Supplied by the client to indicate the maximum printer queue size of limitation.


    Maximum Spooled Output Records

    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.


    Measurement Method

    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.


    Message Help

    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).


    Message ID

    ID
    ATTR_MESSAGEID
    Type
    String
    Description
    The message ID.


    Message Queue

    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.


    Message Reply

    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.


    Message Text

    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.


    Message Type

    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.


    Message Severity

    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.


    Multi-item Reply Capability

    ID
    ATTR_MULTI_ITEM_REPLY
    Type
    String
    Description
    When this attribute value is set to *YES by the client, the performance of list spooled file operations can be greatly improved. The default value is *NO.


    Network Identifier

    ID
    ATTR_NETWORK
    Type
    String
    Description
    The network identifier of the system where the file was created.


    Number of Bytes in Spooled File

    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.


    Number of Bytes to Read/Write

    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.


    Number of Files

    ID
    ATTR_NUMFILES
    Type
    Integer
    Description
    The number of spooled files that exist on the output queue.


    Number of Writers Started to Queue

    ID
    ATTR_NUMWRITERS
    Type
    Integer
    Description
    The number of writer jobs started to the output queue.


    Object Extended Attribute

    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.


    On Job Queue Status

    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.


    Open time commands

    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.


    Operator Controlled

    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.


    Order of Files On Queue

    ID
    ATTR_ORDER
    Type
    String
    Description
    The order of spooled files on this output queue. Valid values are *FIFO, *JOBNBR.


    Output Bin

    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.


    Output Priority

    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.


    Output Queue

    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.


    Output Queue Status

    ID
    ATTR_OUTQSTS
    Type
    String
    Description
    The status of the output queue. Valid values are RELEASED, HELD.


    Overall Status

    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).


    Overflow Line Number

    ID
    ATTR_OVERFLOW
    Type
    Integer
    Description
    The last line to be printed before the data that is being printed overflows to the next page.


    Page At A Time

    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.


    Page Count Estimated

    ID
    ATTR_PAGES_EST
    Type
    String
    Description
    Specifies whether the page count is estimated rather than actual. Valid values are *YES and *NO.


    Page Definition

    ID
    ATTR_PAGE_DEFINITION
    Type
    String
    Description
    The Integrated File System path name of the page definition or a special value. If an Integrated File System path is specified the format is "/QSYS.LIB/library.LIB/pagedef.PAGDFN" where library is the library of the page definition and pagedef is the name of the page definition. Valid special values include *NONE.


    Page Number

    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.


    Pages Per Side

    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.


    Paper Source 1

    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).


    Paper Source 2

    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).


    Pel Density

    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.


    Point Size

    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.


    Print Fidelity

    ID
    ATTR_FIDELITY
    Type
    String
    Description
    The kind of error handling that is performed when printing. Valid values are *ABSOLUTE, *CONTENT.


    Print on Both Sides

    ID
    ATTR_DUPLEX
    Type
    String
    Description
    How the information prints. Valid values are *FORMDF, *NO, *YES, *TUMBLE.


    Print Quality

    ID
    ATTR_PRTQUALITY
    Type
    String
    Description
    The print quality that is used when printing this spooled file. Valid values are *STD, *DRAFT, *NLQ, *FASTDRAFT.


    Print Sequence

    ID
    ATTR_PRTSEQUENCE
    Type
    String
    Description
    Print sequence. Valid values are *NEXT.


    Print Text

    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.


    Printer

    ID
    ATTR_PRINTER
    Type
    String
    Description
    The name of the printer device.


    Printer Assigned

    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).


    Printer Device Type

    ID
    ATTR_PRTDEVTYPE
    Type
    String
    Description
    The printer data stream type. Valid values are *SCS, *IPDS, *USERASCII, *AFPDS, *LINE.


    Printer File

    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.


    Printer Queue

    ID
    ATTR_RMTPRTQ
    Type
    String
    Description
    The name of the destination printer queue when sending spooled files via SNDTCPSPLF (LPR).


    Record Length

    ID
    ATTR_RECLENGTH
    Type
    Integer
    Description
    Record length.


    Reduce Output

    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 ????.


    Remote System

    ID
    ATTR_RMTSYSTEM
    Type
    String
    Description
    Remote system name. Valid special values include *INTNETADR.


    Replace Unprintable Characters

    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.


    Replacement Character

    ID
    ATTR_RPLCHAR
    Type
    String
    Description
    The character that replaces any unprintable characters.


    Restart Printing

    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.


    Saddle Stitch Number of Staples

    ID
    ATTR_SADDLESTITCH_NUMSTAPLES
    Type
    Integer
    Description
    The number of staples that are to be applied along the finishing operation axis.


    Saddle Stitch Reference

    ID
    ATTR_SADDLESTITCH_REF
    Type
    String
    Description
    One or more staples are driven into the media along the finishing operation axis, which is positioned at the center of the media parallel to the reference edge. Valid values are *NONE, *DEVD, *TOP, and *LEFT.


    Save Spooled File

    ID
    ATTR_SAVESPLF
    Type
    String
    Description
    Whether the spooled file is to be saved after it is written. Valid values are *YES, *NO.


    Seek Offset

    ID
    ATTR_SEEKOFF
    Type
    Integer
    Description
    Seek offset. Allows both positive and negative values relative to the seek origin.


    Seek Origin

    ID
    ATTR_SEEKORG
    Type
    Integer
    Description
    Valid values include 1 (beginning or top), 2 (current), and 3 (end or bottom).


    Send Priority

    ID
    ATTR_SENDPTY
    Type
    String
    Description
    Send priority. Valid values are *NORMAL, *HIGH.


    Separator page

    ID
    ATTR_SEPPAGE
    Type
    String
    Description
    Allows a user the option of printing a banner page or not. Valid values are *YES or *NO.


    Source Drawer

    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 encoded as -1, and the value *FORMDF is encoded as -2.


    Spool SCS

    ID
    ATTR_SPLSCS
    Type
    Long
    Description
    Determines how SCS data is used during create spool file.


    Spool the Data

    ID
    ATTR_SPOOL
    Type
    String
    Description
    Whether the output data for the printer device is spooled. Valid values are *YES, *NO.


    Spooled File Creation Authentication Method

    ID
    ATTR_SPLF_AUTH_METHOD
    Type
    Integer
    Description
    Indicates the client authentication method used to create this spooled file. Valid values include x'00'(*NONE), x'01'(*REQUESTER), x'02'(*BASIC), x'03'(*CERTIFICATE), and 'x'04'(*DIGEST).


    Spooled File Creation Security Method

    ID
    ATTR_SPLF_SECURITY_METHOD
    Type
    String
    Description
    Indicates the security method used to create this spooled file. Valid values are x'00'(*NONE), x'01'(*SSL3), and x'02'(*TLS).


    Spooled File Name

    ID
    ATTR_SPOOLFILE
    Type
    String
    Description
    The name of the spooled file.


    Spooled File Number

    ID
    ATTR_SPLFNUM
    Type
    Integer
    Description
    The spooled file number. Special values allowed are -1 and 0. The value *LAST is encoded as -1, the value *ONLY is encoded as 0.


    Spooled File Status

    ID
    ATTR_SPLFSTATUS
    Type
    String
    Description
    The status of the spooled file. Valid values are *CLOSED, *HELD, *MESSAGE, *OPEN, *PENDING, *PRINTER, *READY, *SAVED, *WRITING.


    Spooled Output Schedule

    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.


    Started By User

    ID
    ATTR_STARTEDBY
    Type
    String
    Description
    The name of the user who started the writer.


    Starting Page

    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.


    System Where Created

    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.


    Text Description

    ID
    ATTR_DESCRIPTION
    Type
    String
    Description
    Text to describe an instance of an AS/400 object.


    Time File Opened

    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.


    Time Writer Began Processing Spooled File

    ID
    ATTR_TIME_WTR_BEGAN_FILE
    Type
    String
    Description
    Indicates the time at which the writer began processing the spooled file. The time is encoded in a character string with the following format, HH MM SS.


    Time Writer Completed Processing Spooled File

    ID
    ATTR_TIME_WTR_CMPL_FILE
    Type
    String
    Description
    Indicates the time at which the writer finished processing the spooled file. The time is encoded in a character string with the following format, HH MM SS.


    Total Pages

    ID
    ATTR_PAGES
    Type
    Integer
    Description
    The number of pages that are contained in a spooled file.


    Transform SCS to ASCII

    ID
    ATTR_SCS2ASCII
    Type
    String
    Description
    Whether the print data is to be transformed from SCS to ASCII. Valid values are *YES, *NO.


    Unit of Measure

    ID
    ATTR_UNITOFMEAS
    Type
    String
    Description
    The unit of measure to use for specifying distances. Valid values are *CM, *INCH.


    User Comment

    ID
    ATTR_USERCMT
    Type
    String
    Description
    The 100 characters of user-specified comment that describe the spooled file.


    User Data

    ID
    ATTR_USERDATA
    Type
    String
    Description
    The 10 characters of user-specified data that describe the spooled file. Valid special values include *SOURCE.


    User Defined Data

    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.


    User Defined File

    ID
    ATTR_USRDEFFILE
    Type
    String
    Description
    Whether the spooled file was created using an API. Valid values are *YES, or *NO.


    User Defined Object

    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.


    User Defined Option(s)

    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.


    User Driver Program Data

    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.


    User Driver Program

    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.


    User ID

    ID
    ATTR_TOUSERID
    Type
    String
    Description
    User id to whom the spooled file is sent.


    User ID Address

    ID
    ATTR_TOADDRESS
    Type
    String
    Description
    Address of user to whom the spooled file is sent.


    User Transform Program

    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.


    Viewing Fidelity

    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.


    VM/MVS Class

    ID
    ATTR_VMMVSCLASS
    Type
    String
    Description
    VM/MVS class. Valid values are A-Z and 0-9.


    When to Automatically End Writer

    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.


    Waiting for Data Status

    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.


    Waiting for Device Status

    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.


    Waiting for Message Status

    ID
    ATTR_WTNGMSGSTS
    Type
    String
    Description
    Whether the writer is waiting for a reply to an inquiry message. Values are *NO and *YES.


    When to End Writer

    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.


    When to Hold File

    ID
    ATTR_HOLDTYPE
    Type
    String
    Description
    When to hold the spooled file. Valid values are *IMMED, and *PAGEEND.


    Width of Page

    ID
    ATTR_PAGEWIDTH
    Type
    Float
    Description
    The width of a page. Units of measurement are specified in the measurement method attribute.


    Workstation Customizing Object

    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.


    Writer Job Name

    ID
    ATTR_WRITER
    Type
    String
    Description
    The name of the writer job.


    Writer Job Number

    ID
    ATTR_WTRJOBNUM
    Type
    String
    Description
    The writer job number.


    Writer Job Status

    ID
    ATTR_WTRJOBSTS
    Type
    String
    Description
    The status of the writer job. Valid values are STR, END, JOBQ, HLD, MSGW.


    Writer Job User Name

    ID
    ATTR_WTRJOBUSER
    Type
    String
    Description
    The name of the user that started the writer job.


    Writer Started

    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.


    Writer Starting Page

    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.


    Writing Status

    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.


    Network Print Server Object Attributes

    NPS CCSID

    ID
    ATTR_NPSCCSID
    Type
    Integer
    Description
    CCSID that the Network Print Server expects that all strings will be encoded in.

    NPS Level

    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)