.| 1 | Spooled file handle | Output | Binary(4) |
| 2 | Spooled file attributes | Input | Char(*) |
| 3 | Error Code | I/O | Char(*) |
The Create Spooled File (QSPCRTSP) API is used to create a new spooled file with attributes based on values taken from the spooled file attributes parameter. The field values of the spooled file attributes can be obtained using the Retrieve Spooled File Attributes (QUSRSPLA) API. The fields can also be defined by a user application.
The API authority is set this way so that system administrators can control the use of this API. This API has security implications because you can create a spooled file from the data of another spooled file.
The handle to be used by subsequent put (QSPPUTSP API) and close (QSPCLOSP API) operations to identify the spooled file.
Attributes returned into the receiver variable by a prior Retrieve Spooled File Attributes (QUSRSPLA) API call with format SPLA0200 specified. These attributes are used to create the new spooled file.
The structure in which to return error information. For the format of the structure, see Error code parameter.
The following special considerations apply when using the QSPCRTSP API.
When you use the QSPCRTSP API, all system values must be uppercase for IBM® i to recognize them.
The spooled file that is created by the QSPCRTSP API is spooled under one of two jobs. The job is determined by the user-name field. If the user name is the current user, it is a part of the user's job and is owned by the user profile that the job was started with.
However, ownership of the new spooled file can be assigned to a different user by specifying a different user profile name in the user-name field. The current user must have *SPLCTL authority to assign the spooled file to another user. When this is done, the new spooled file is by the user specified in the user-name field. The new spooled file is then part of a special system job (QPRTJOB) that is created for each user.
The user profile for the user name must already exist.
The new spooled file is placed on the output queue specified in the output queue name field. If the output queue is to correspond to the output queue of the user profile, the user application can use the Retrieve User Profile (RTVUSRPRF) command or the Retrieve User Information (QSYRUSRI) API to retrieve the output queue name.
In both cases, the spooled file name is the one contained in the spooled file attributes parameter. The spooled file number is the next sequential one available for the job that the spooled file becomes a part of.
In both cases (if you are in the System/36™ environment), the system assigns a new System/36 spooled file identifier and a new internal spooled file identifier.
Many of the fields returned by the Retrieve Spooled File Attributes (QUSRSPLA) are closely interrelated with other fields. Changing these field values can lead to unexpected results.
Error messages can be CPIxxxx or CPFxxxx. Error messages that start with CPI are informational and do not stop the job from running. These messages are stored in the job log.
Error messages that start with CPF cause the job to stop running. These messages are returned to the application program. The form in which they are returned is determined by the error code parameter.
Error checking on the fields includes:
Note: If a default is used, that value is obtained from the device file.
When a value is specified that is not valid, message CPI33E2 is issued and the field default is used.
When the field specifies a system name and the name is not valid, message CPF33E2 is issued. In the other cases, message CPI33E2 is issued and the default for that field is taken.
Message CPF33E2 is issued when the value of one field must correspond to a specific value of another field.
The following table presents, in the same order, all of the fields of format SPLA0200. It contains the following entries:
| Used | This column indicates whether this field is used
in describing a new spooled file.
|
||||||
| Cross-dependency | This column indicates whether this field is
dependent on other fields.
|
SPLA0200 Format Field Names and Descriptions
The following table shows the information returned for the SPLA0200 format. For more details about the fields in the following table, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Bytes returned Used: Y Cross-dependency: N |
| 4 | 4 | BINARY(4) | Bytes available Used: N Cross-dependency: N/A |
| 8 | 8 | CHAR(8) | Format name Used: Y Cross-dependency: N |
| 16 | 10 | CHAR(16) | Internal job identifier Used: N Cross-dependency: N/A |
| 32 | 20 | CHAR(16) | Internal spooled file identifier Used: N Cross-dependency: N/A |
| 48 | 30 | CHAR(10) | Job name Used: N Cross-dependency: N/A |
| 58 | 3A | CHAR(10) | User name Used: Y Cross-dependency: Y |
| 68 | 44 | CHAR(6) | Job number Used: N Cross-dependency: N/A |
| 74 | 4A | CHAR(10) | Spooled file name Used: Y Cross-dependency: N |
| 84 | 54 | BINARY(4) | Spooled file number Used: N Cross-dependency: N/A |
| 88 | 58 | CHAR(10) | Form type Used: Y Cross-dependency: N |
| 98 | 62 | CHAR(10) | User-specified data Used: Y Cross-dependency: N |
| 108 | 6C | CHAR(10) | Status Used: N Cross-dependency: N/A |
| 118 | 76 | CHAR(10) | File available Used: Y Cross-dependency: N |
| 128 | 80 | CHAR(10) | Hold file before written Used: Y Cross-dependency: N |
| 138 | 8A | CHAR(10) | Save file after written Used: Y Cross-dependency: N |
| 148 | 94 | BINARY(4) | Total pages Used: Y Cross-dependency: N |
| 152 | 98 | BINARY(4) | Page or record being written Used: N Cross-dependency: N/A |
| 156 | 9C | BINARY(4) | Starting page Used: Y Cross-dependency: N |
| 160 | A0 | BINARY(4) | Ending page Used: Y Cross-dependency: N |
| 164 | A4 | BINARY(4) | Last page printed Used: N Cross-dependency: N/A |
| 168 | A8 | BINARY(4) | Restart printing Used: Y Cross-dependency: N |
| 172 | AC | BINARY(4) | Total copies Used: N Cross-dependency: N |
| 176 | B0 | BINARY(4) | Copies left to produce Used: Y Cross-dependency: N |
| 180 | B4 | BINARY(4) | Lines per inch Used: Y Cross-dependency: Y |
| 184 | B8 | BINARY(4) | Characters per inch Used: Y Cross-dependency: Y |
| 188 | BC | CHAR(2) | Output priority Used: Y Cross-dependency: N |
| 190 | BE | CHAR(10) | Output queue name Used: Y Cross-dependency: N |
| 200 | C8 | CHAR(10) | Output queue library name Used: Y Cross-dependency: N |
| 210 | D2 | CHAR(7) | Date file opened (created) Used: N Cross-dependency: N/A |
| 217 | D9 | CHAR(6) | Time file opened (created) Used: N Cross-dependency: N/A |
| 223 | DF | CHAR(10) | Device file name Used: Y Cross-dependency: Y |
| 233 | E9 | CHAR(10) | Device file library name Used: Y Cross-dependency: Y |
| 243 | F3 | CHAR(10) | Program that opened file name Used: Y Cross-dependency: Y |
| 253 | FD | CHAR(10) | Program that opened file library name Used: Y Cross-dependency: Y |
| 263 | 107 | CHAR(15) | Accounting code Used: Y Cross-dependency: N |
| 278 | 116 | CHAR(30) | Print text Used: Y Cross-dependency: N |
| 308 | 134 | BINARY(4) | Record length Used: Y Cross-dependency: Y |
| 312 | 138 | BINARY(4) | Maximum records Used: Y Cross-dependency: N |
| 316 | 13C | CHAR(10) | Device type Used: N Cross-dependency: N |
| 326 | 146 | CHAR(10) | Printer device type Used: Y Cross-dependency: Y |
| 336 | 150 | CHAR(12) | Document name Used: Y Cross-dependency: Y |
| 348 | 15C | CHAR(64) | Folder name Used: Y Cross-dependency: Y |
| 412 | 19C | CHAR(8) | System/36 procedure name Used: Y Cross-dependency: N |
| 420 | 1A4 | CHAR(10) | Print fidelity Used: Y Cross-dependency: Y |
| 430 | 1AE | CHAR(1) | Replace unprintable characters Used: Y Cross-dependency: N |
| 431 | 1AF | CHAR(1) | Replacement character Used: Y Cross-dependency: Y |
| 432 | 1B0 | BINARY(4) | Page length Used: Y Cross-dependency: Y |
| 436 | 1B4 | BINARY(4) | Page width Used: Y Cross-dependency: Y |
| 440 | 1B8 | BINARY(4) | Number of separators Used: Y Cross-dependency: N |
| 444 | 1BC | BINARY(4) | Overflow line number Used: Y Cross-dependency: Y |
| 448 | 1C0 | CHAR(10) | DBCS data Used: Y Cross-dependency: Y |
| 458 | 1CA | CHAR(10) | DBCS extension characters Used: Y Cross-dependency: Y |
| 468 | 1D4 | CHAR(10) | DBCS shift-out shift-in (SO/SI) spacing Used: Y Cross-dependency: Y |
| 478 | 1DE | CHAR(10) | DBCS character rotation Used: Y Cross-dependency: Y |
| 488 | 1E8 | BINARY(4) | DBCS characters per inch Used: Y Cross-dependency: Y |
| 492 | 1EC | CHAR(10) | Graphic character set Used: Y Cross-dependency: Y |
| 502 | 1F6 | CHAR(10) | Code page Used: Y Cross-dependency: Y |
| 512 | 200 | CHAR(10) | Form definition name Used: Y Cross-dependency: Y |
| 522 | 20A | CHAR(10) | Form definition library name Used: Y Cross-dependency: Y |
| 532 | 214 | BINARY(4) | Source drawer Used: Y Cross-dependency: Y |
| 536 | 218 | CHAR(10) | Printer font Used: Y Cross-dependency: Y |
| 546 | 222 | CHAR(6) | System/36 spooled file identifier Used: N Cross-dependency: N/A |
| 552 | 228 | BINARY(4) | Page rotation Used: Y Cross-dependency: N |
| 556 | 22C | BINARY(4) | Justification Used: Y Cross-dependency: N |
| 560 | 230 | CHAR(10) | Print on both sides (duplex) Used: Y Cross-dependency: Y |
| 570 | 23A | CHAR(10) | Fold records Used: Y Cross-dependency: N |
| 580 | 244 | CHAR(10) | Control character Used: Y Cross-dependency: Y |
| 590 | 24E | CHAR(10) | Align forms Used: Y Cross-dependency: N |
| 600 | 258 | CHAR(10) | Print quality Used: Y Cross-dependency: N |
| 610 | 262 | CHAR(10) | Form feed Used: Y Cross-dependency: N |
| 620 | 26C | CHAR(71) | Volumes (array) Used: N Cross-dependency: N/A |
| 691 | 2B3 | CHAR(17) | File label identifier Used: N Cross-dependency: N/A |
| 708 | 2C4 | CHAR(10) | Exchange type Used: N Cross-dependency: N/A |
| 718 | 2CE | CHAR(10) | Character code Used: N Cross-dependency: N/A |
| 728 | 2D8 | BINARY(4) | Total records Used: Y Cross-dependency: N |
| 732 | 2DC | BINARY(4) | Multiple up (pages per side) Used: Y Cross-dependency: N |
| 736 | 2E0 | CHAR(10) | Front overlay name Used: Y Cross-dependency: Y |
| 746 | 2EA | CHAR(10) | Front overlay library name Used: Y Cross-dependency: Y |
| 756 | 2F4 | PACKED(15,5) | Front overlay offset down Used: Y Cross-dependency: Y |
| 764 | 2FC | PACKED(15,5) | Front overlay offset across Used: Y Cross-dependency: Y |
| 772 | 304 | CHAR(10) | Back overlay name Used: Y Cross-dependency: Y |
| 782 | 30E | CHAR(10) | Back overlay library name Used: Y Cross-dependency: Y |
| 792 | 318 | PACKED(15,5) | Back overlay offset down Used: Y Cross-dependency: Y |
| 800 | 320 | PACKED(15,5) | Back overlay offset across Used: Y Cross-dependency: Y |
| 808 | 328 | CHAR(10) | Unit of measure Used: Y Cross-dependency: Y |
| 818 | 332 | CHAR(10) | Page definition name Used: Y Cross-dependency: Y |
| 828 | 33C | CHAR(10) | Page definition library name Used: Y Cross-dependency: Y |
| 838 | 346 | CHAR(10) | Line spacing Used: Y Cross-dependency: Y |
| 848 | 350 | PACKED(15,5) | Point size Used: Y Cross-dependency: Y |
| 856 | 358 | BINARY(4) | Maximum spooled data record size Used: Y Cross-dependency: Y |
| 860 | 35C | BINARY(4) | Spooled file buffer size Used: Y Cross-dependency: N |
| 864 | 360 | CHAR(6) | Spooled file level Used: Y Cross-dependency: N |
| 870 | 366 | ARRAY(4) | Coded font array Used: Y Cross-dependency: Y |
| 886 | 376 | CHAR(10) | Channel mode Used: Y Cross-dependency: Y |
| 896 | 380 | ARRAY(12) | Channel value array Used: Y Cross-dependency: Y |
| 944 | 3B0 | CHAR(8) | Graphics token Used: Y Cross-dependency: Y |
| 952 | 3B8 | CHAR(10) | Record format Used: Y Cross-dependency: Y |
| 962 | 3C2 | CHAR(2) | Reserved |
| 964 | 3C4 | PACKED(15,5) | Height of drawer 1 Used: Y Cross-dependency: Y |
| 972 | 3CC | PACKED(15,5) | Width of drawer 1 Used: Y Cross-dependency: Y |
| 980 | 3D4 | PACKED(15,5) | Height of drawer 2 Used: Y Cross-dependency: Y |
| 988 | 3DC | PACKED(15,5) | Width of drawer 2 Used: Y Cross-dependency: Y |
| 996 | 3E4 | BINARY(4) | Number of buffers Used: N Cross-dependency: N/A |
| 1000 | 3E8 | BINARY(4) | Maximum forms width Used: Y Cross-dependency: N |
| 1004 | 3EC | BINARY(4) | Alternate forms width Used: Y Cross-dependency: Y |
| 1008 | 3F0 | BINARY(4) | Alternate forms length Used: Y Cross-dependency: Y |
| 1012 | 3F4 | BINARY(4) | Alternate lines per inch Used: Y Cross-dependency: Y |
| 1016 | 3F8 | CHAR(2) | System/38™ Text Utility flags Used: Y Cross-dependency: N |
| 1018 | 3FA | CHAR(1) | File open Used: Y Cross-dependency: N |
| 1019 | 3FB | CHAR(1) | Page count estimated Used: Y Cross-dependency: Y |
| 1020 | 3FC | CHAR(1) | File stopped on page boundary Used: Y Cross-dependency: N |
| 1021 | 3FD | CHAR(1) | TRC for 1403 Used: Y Cross-dependency: Y |
| 1022 | 3FE | CHAR(1) | Define characters Used: Y Cross-dependency: Y |
| 1023 | 3FF | CHAR(1) | Characters per inch changes Used: Y Cross-dependency: Y |
| 1024 | 400 | CHAR(1) | Transparency Used: Y Cross-dependency: Y |
| 1025 | 401 | CHAR(1) | Double-wide characters Used: Y Cross-dependency: Y |
| 1026 | 402 | CHAR(1) | DBCS character rotation commands Used: Y Cross-dependency: Y |
| 1027 | 403 | CHAR(1) | Extended code page Used: Y Cross-dependency: Y |
| 1028 | 404 | CHAR(1) | FFT emphasis Used: Y Cross-dependency: Y |
| 1029 | 405 | CHAR(1) | 3812 SCS Used: Y Cross-dependency: Y |
| 1030 | 406 | CHAR(1) | Set Line Density command Used: Y Cross-dependency: Y |
| 1031 | 407 | CHAR(1) | Graphics error actions Used: Y Cross-dependency: Y |
| 1032 | 408 | CHAR(1) | 5219 commands Used: Y Cross-dependency: Y |
| 1033 | 409 | CHAR(1) | 3812 SCS commands Used: Y Cross-dependency: Y |
| 1034 | 40A | CHAR(1) | Field outlining Used: Y Cross-dependency: Y |
| 1035 | 40B | CHAR(1) | Final form text Used: Y Cross-dependency: Y |
| 1036 | 40C | CHAR(1) | Bar code Used: Y Cross-dependency: Y |
| 1037 | 40D | CHAR(1) | Color Used: Y Cross-dependency: Y |
| 1038 | 40E | CHAR(1) | Drawer change Used: Y Cross-dependency: Y |
| 1039 | 40F | CHAR(1) | Character ID Used: Y Cross-dependency: Y |
| 1040 | 410 | CHAR(1) | Lines per inch changes Used: Y Cross-dependency: Y |
| 1041 | 411 | CHAR(1) | Font Used: Y Cross-dependency: Y |
| 1042 | 412 | CHAR(1) | Highlight Used: Y Cross-dependency: Y |
| 1043 | 413 | CHAR(1) | Page rotate Used: Y Cross-dependency: Y |
| 1044 | 414 | CHAR(1) | Subscript Used: Y Cross-dependency: Y |
| 1045 | 415 | CHAR(1) | Superscript Used: Y Cross-dependency: Y |
| 1046 | 416 | CHAR(1) | DDS Used: Y Cross-dependency: Y |
| 1047 | 417 | CHAR(1) | Final form feed Used: Y Cross-dependency: Y |
| 1048 | 418 | CHAR(1) | SCS data Used: Y Cross-dependency: Y |
| 1049 | 419 | CHAR(1) | User-generated data stream Used: Y Cross-dependency: Y |
| 1050 | 41A | CHAR(1) | Graphics Used: Y Cross-dependency: Y |
| 1051 | 41B | CHAR(1) | Unrecognizable data Used: Y Cross-dependency: Y |
| 1052 | 41C | CHAR(1) | ASCII transparency Used: Y Cross-dependency: Y |
| 1053 | 41D | CHAR(1) | IPDS™ transparent data Used: Y Cross-dependency: N |
| 1054 | 41E | CHAR(1) | OfficeVision® Used: Y Cross-dependency: N |
| 1055 | 41F | CHAR(1) | Lines-per-inch (lpi) value not supported Used: Y Cross-dependency: N |
| 1056 | 420 | CHAR(1) | CPA3353 message Used: Y Cross-dependency: N |
| 1057 | 421 | CHAR(1) | Set exception Used: Y Cross-dependency: Y |
| 1058 | 422 | CHAR(1) | Carriage control characters Used: Y Cross-dependency: Y |
| 1059 | 423 | CHAR(1) | Page position Used: Y Cross-dependency: Y |
| 1060 | 424 | CHAR(1) | Character not valid Used: Y Cross-dependency: Y |
| 1061 | 425 | CHAR(1) | Lengths present Used: Y Cross-dependency: Y |
| 1062 | 426 | CHAR(1) | 5A present Used: Y Cross-dependency: Y |
| 1063 | 427 | CHAR(1) | Reserved |
| 1064 | 428 | BINARY(4) | Number of font array entries Used: Y Cross-dependency: Y |
| 1068 | 42C | BINARY(4) | Number of resource library entries Used: N Cross-dependency: N |
| 1072 | 430 | CHAR(1153) | Font equivalence array Used: Y Cross-dependency: Y |
| 2225 | 8B1 | CHAR(631) | Resource library array Used: N Cross-dependency: N |
| 2856 | B28 | CHAR(1) | IBM i-created AFPDS Used: Y Cross-dependency: Y |
| 2857 | B29 | CHAR(1) | Job character ID specified Used: Y Cross-dependency: Y |
| 2858 | B2A | CHAR(1) | S36 CONTINUE-YES Used: Y Cross-dependency: N |
| 2859 | B2B | CHAR(10) | Decimal format Used: Y Cross-dependency: N |
| 2869 | B35 | CHAR(7) | Date file last used Used: N Cross-dependency: N/A |
| 2876 | B3C | CHAR(1) | Page groups Used: Y Cross-dependency: Y |
| 2877 | B3D | CHAR(1) | Group level index tags Used: Y Cross-dependency: Y |
| 2878 | B3E | CHAR(1) | Page level index tags Used: Y Cross-dependency: Y |
| 2879 | B3F | CHAR(1) | IPDS pass-through Used: Y Cross-dependency: N |
| 2880 | B40 | BINARY(4) | Offset to user resource library list Used: Y Cross-dependency: Y |
| 2884 | B44 | BINARY(4) | Number of user resource library list entries Used: Y Cross-dependency: Y |
| 2888 | B48 | BINARY(4) | Length of user resource library list entry Used: Y Cross-dependency: Y |
| 2892 | B4C | CHAR(2) | Reserved |
| 2894 | B4E | CHAR(1) | Corner staple Used: Y Cross-dependency: N |
| 2895 | B4F | CHAR(1) | Edge-stitch reference edge Used: Y Cross-dependency: Y |
| 2896 | B50 | PACKED(15,5) | Offset from edge-stitch reference edge Used: Y Cross-dependency: Y |
| 2904 | B58 | BINARY(4) | Edge-stitch number of staples Used: Y Cross-dependency: Y |
| 2908 | B5C | BINARY(4) | Offset to edge-stitch staple offset list Used: Y Cross-dependency: Y |
| 2912 | B60 | BINARY(4) | Number of edge-stitch staple offset entries Used: Y Cross-dependency: Y |
| 2916 | B64 | BINARY(4) | Length of edge-stitch staple offset entry Used: Y Cross-dependency: Y |
| 2920 | B68 | CHAR(10) | Font resolution for formatting Used: Y Cross-dependency: N |
| 2930 | B72 | CHAR(1) | Record format name present in data stream Used: Y Cross-dependency: Y |
| 2931 | B73 | CHAR(1) | Saddle-stitch reference edge Used: Y Cross-dependency: Y |
| 2932 | B74 | BINARY(4) | Saddle-stitch number of staples Used: Y Cross-dependency: Y |
| 2936 | B78 | BINARY(4) | Offset to saddle-stitch staple offset list Used: Y Cross-dependency: Y |
| 2940 | B7C | BINARY(4) | Number of saddle-stitch staple offset entries Used: Y Cross-dependency: Y |
| 2944 | B80 | BINARY(4) | Length of saddle-stitch staple offset entry Used: Y Cross-dependency: Y |
| 2948 | B84 | PACKED(15,0) | Data stream size Used: N Cross-dependency: N |
| 2956 | B8C | BINARY(4) | Offset to library list Used: N Cross-dependency: N |
| 2960 | B90 | BINARY(4) | Number of library list entries Used: N Cross-dependency: N |
| 2964 | B94 | BINARY(4) | Length of library list entry Used: N Cross-dependency: N |
| 2968 | B98 | BINARY(4) | Offset to Internet Print Protocol spooled file
attributes Used: N Cross-dependency: N/A |
| 2972 | B9C | BINARY(4) | Offset to Save and Restore spooled file
attributes Used: N Cross-dependency: N/A |
| 2976 | BA0 | BINARY(4) | CCSID of job Used: Y Cross-dependency: N |
| 2980 | BA4 | CHAR(172) | Reserved |
| 3152 | C50 | PACKED(15,5) | Front margin offset down Used: Y Cross-dependency: Y |
| 3160 | C58 | PACKED(15,5) | Front margin offset across Used: Y Cross-dependency: Y |
| 3168 | C60 | PACKED(15,5) | Back margin offset down Used: Y Cross-dependency: Y |
| 3176 | C68 | PACKED(15,5) | Back margin offset across Used: Y Cross-dependency: Y |
| 3184 | C70 | PACKED(15,5) | Length of page Used: Y Cross-dependency: Y |
| 3192 | C78 | PACKED(15,5) | Width of page Used: Y Cross-dependency: Y |
| 3200 | C80 | CHAR(10) | Measurement method Used: Y Cross-dependency: Y |
| 3210 | C8A | CHAR(1) | Advanced Function Presentation™ (AFP™) resource Used: Y Cross-dependency: Y |
| 3211 | C8B | CHAR(10) | Character set name Used: Y Cross-dependency: Y |
| 3221 | C95 | CHAR(10) | Character set library name Used: Y Cross-dependency: Y |
| 3231 | C9F | CHAR(10) | Code page name Used: Y Cross-dependency: Y |
| 3241 | CA9 | CHAR(10) | Code page library name Used: Y Cross-dependency: Y |
| 3251 | CB3 | CHAR(10) | Coded font name Used: Y Cross-dependency: Y |
| 3261 | CBD | CHAR(10) | Coded font library name Used: Y Cross-dependency: Y |
| 3271 | CC7 | CHAR(10) | DBCS-coded font name Used: Y Cross-dependency: Y |
| 3281 | CD1 | CHAR(10) | DBCS-coded font library name Used: Y Cross-dependency: Y |
| 3291 | CDB | CHAR(10) | User-defined file Used: N Cross-dependency: N |
| 3301 | CE5 | CHAR(10) | Reduce output Used: Y Cross-dependency: Y |
| 3311 | CEF | CHAR(1) | Constant back overlay Used: Y Cross-dependency: Y |
| 3312 | CF0 | BINARY(4) | Output bin Used: Y Cross-dependency: N |
| 3316 | CF4 | BINARY(4) | CCSID Used: Y Cross-dependency: N |
| 3320 | CF8 | CHAR(100) | User-defined text Used: Y Cross-dependency: N |
| 3420 | D5C | CHAR(8) | System where file originated Used: Y Cross-dependency: N |
| 3428 | D64 | CHAR(8) | Net ID where file originated Used: Y Cross-dependency: N |
| 3436 | D6C | CHAR(10) | User who created file Used: Y Cross-dependency: N |
| 3446 | D76 | CHAR(2) | Reserved |
| 3448 | D78 | BINARY(4) | Offset to user-defined options Used: Y Cross-dependency: Y |
| 3452 | D7C | BINARY(4) | Number of user-defined options returned Used: Y Cross-dependency: Y |
| 3456 | D80 | BINARY(4) | Length of each user-defined option entry Used: Y Cross-dependency: Y |
| 3460 | D84 | CHAR(255) | User-defined data Used: Y Cross-dependency: N |
| 3715 | E83 | CHAR(10) | User-defined object name Used: Y Cross-dependency: Y |
| 3725 | E8D | CHAR(10) | User-defined object library name Used: Y Cross-dependency: Y |
| 3735 | E97 | CHAR(10) | User object type Used: Y Cross-dependency: Y |
| 3745 | EA1 | CHAR(3) | Reserved |
| 3748 | EA4 | PACKED(15,5) | Character set point size Used: Y Cross-dependency: Y |
| 3756 | EAC | PACKED(15,5) | Coded font point size Used: Y Cross-dependency: Y |
| 3764 | EB4 | PACKED(15,5) | DBCS-coded font point size Used: Y Cross-dependency: Y |
| 3772 | EBC | BINARY(4) | Auxiliary storage pool Used: N Cross-dependency: N/A |
| 3776 | EC0 | BINARY(4) | Spooled file size Used: N Cross-dependency: N/A |
| 3780 | EC4 | BINARY(4) | Spooled file size multiplier Used: N Cross-dependency: N/A |
| 3784 | EC8 | BINARY(4) | Internet print protocol job identifier Used: N Cross-dependency: N/A |
| 3788 | ECC | CHAR(1) | Spooled file creation security method Used: Y Cross-dependency: N |
| 3789 | ECD | CHAR(1) | Spooled file creation authentication method Used: Y Cross-dependency: N |
| 3790 | ECE | CHAR(7) | Date writer began processing spooled file Used: N Cross-dependency: N/A |
| 3797 | ED5 | CHAR(6) | Time writer began processing spooled file Used: N Cross-dependency: N/A |
| 3803 | EDB | CHAR(7) | Date writer completed processing spooled file Used: N Cross-dependency: N/A |
| 3810 | EE2 | CHAR(6) | Time writer completed processing spooled file Used: N Cross-dependency: N/A |
| 3816 | EE8 | CHAR(8) | Job system name Used: N Cross-dependency: N/A |
| 3824 | EF0 | CHAR(10) | Auxiliary storage pool device name Used: N Cross-dependency: N/A |
| 3834 | EFA | CHAR(7) | Expiration date Used: Y Cross-dependency: N |
Accounting code. An identifier assigned by the system to record the resources used to write this spooled file. This can be retrieved for the user owning the spooled file by using the Retrieve User Profile (RTVUSRPRF) command or the Retrieve User Information (QSYRUSRI) API, specifying the ACGCDE parameter.
Advanced Function Presentation (AFP) resource. Whether this spooled file refers to AFP resources external to this spooled file, for example, page segments or overlays.
The possible values are:
| Y | The spooled file refers to AFP resources external to the spooled file. |
| N | The spooled file does not refer to AFP resources external to the spooled file. |
Align forms. Whether a forms alignment message is sent prior to printing the data. The options are *YES or *NO.
Alternate forms length. The length of the alternate forms in lines. This field applies only to spooled files created by the OfficeVision program and should be set to 0 by an application building this format as opposed to retrieving the fields. The other alternate forms fields should also be set to 0.
Alternate forms width. The width of the alternate forms in character positions. This field applies only to spooled files created by the OfficeVision program and should be set to 0 by an application building this format as opposed to retrieving the fields. The other alternate forms fields should also be set to 0.
Alternate lines per inch. The lines per inch for the alternate forms. This field applies only to spooled files created by the OfficeVision program and should be set to 0 by an application building this format as opposed to retrieving the fields. The other alternate forms fields should also be set to 0.
ASCII transparency. For SCS files, whether ASCII commands are embedded in the ASCII transparency command. The ASCII transparency command is command_ID/command_length/ASCII_data. The command ID is a 1-byte field with the value hex 03. The command length is a 1-byte field that contains the length of the command length field and the ASCII data field.
Valid values are Y (yes) or N (no). This field should be set to N when creating a spooled file as opposed to copying an existing spooled file.
Auxiliary storage pool. The number of the auxiliary storage pool (ASP) that the spooled file is stored on.
Auxiliary storage pool device name. The name of the auxiliary storage pool (ASP) device that the spooled file is stored on.
Back margin offset across. For the back side of a piece of
paper, in either inches or centimeters (specified in the unit of measure (UOM)
parameter), how far from the left side of the page printing starts.
The possible values are:
| 0-57.79 | The offset in inches or centimeters, according to the unit of measure field. The maximum offset is 57.79 centimeters or 22.75 inches. |
This field should only be specified for spooled files with device types of *LINE, *AFPDSLINE, or *AFPDS if the spooled file was created on a System i™ platform. See IBM i-created *AFPDS field.
If this field is not specified for one of these valid types, a default value is used.
Back margin offset down. For the back side of a piece of paper, in either inches or centimeters (specified in the unit of measure (UOM) parameter), how far down from the top of the page printing starts.
The possible values are:
| -1 | The back margin offsets are the same as the front margin offsets. |
| -2 | *DEVD. For printers configured AFP(*YES), no print border is used for back margin offsets across and down. Otherwise, the offset values are 0. |
| 0-57.79 | The offset in inches or centimeters, according to the unit of measure field. The maximum offset is 57.79 centimeters or 22.75 inches. |
This field should only be specified for spooled files with device types of *LINE, *AFPDSLINE, or *AFPDS if the spooled file was created on a System i platform. See IBM i-created *AFPDS field.
If this field is not specified for one of these valid types, a default value is used.
Back overlay library name. The name of the library containing the back overlay.
The possible values are:
| *CURLIB | The current library for the job locates the back overlay. |
| *LIBL | The library list locates the back overlay. |
| library name | This library is searched for the back overlay. |
This field should only be specified for spooled files with device types of *SCS, *IPDS, or *AFPDS if the spooled file was created on a System i platform. See IBM i-created *AFPDS field.
If this field is not specified for one of these valid types, a default value is used.
Back overlay name. The name of the back overlay (the material that prints on the back side of each page).
The possible values are:
| *FRONTOVL | The back overlay is the same as the front overlay. |
| *NONE | The file does not use a back overlay. |
| back overlay name | The name of the back overlay. |
If an overlay name is specified, the back overlay library name must also be specified.
This field should only be specified for spooled files with device types of *SCS, *IPDS, or *AFPDS if the spooled file was created on a System i platform. See IBM i-created *AFPDS field.
If this field is not specified for one of these valid types, a default value is used.
Back overlay offset across. The offset across from the point of origin where the overlay is printed.
The possible values are:
| 0-57.79 | The offset in inches or centimeters, according to the unit of measure field. The maximum offset is 57.79 centimeters or 22.75 inches. |
This field should only be specified for spooled files with device types of *SCS, *IPDS, or *AFPDS if the spooled file was created on a System i platform. See IBM i-created *AFPDS field.
If this field is not specified for one of these valid types, a default value is used.
Back overlay offset down. The offset down from the point of
origin where the overlay is printed.
The possible values are:
| 0-57.79 | The offset in inches or centimeters, according to the unit of measure field. The maximum offset is 57.79 centimeters or 22.75 inches. |
This field should only be specified for spooled files with device types of *SCS, *IPDS, or *AFPDS if the spooled file was created on a System i platform. See IBM i-created *AFPDS field.
If this field is not specified for one of these valid types, a default value is used.
Bar code. Whether the spooled file contains bar codes created using the BARCODE keyword in the data description specifications (DDS).
For DEVTYPE(*IPDS and *AFPDS), a series of bar code commands is contained in the data stream.
Valid values are Y (yes) or N (no). Set this field to N for all other printer device types.
Bytes available. The number of bytes of data available to be returned. All available data is returned if enough space is provided.
Bytes returned. The total number of bytes contained in the field format. This must be the length of format SPLA0200 plus the length of the user-defined options.
Carriage control characters. Whether the file has machine carriage control characters.
Valid values are Y (yes) or N (no).
CCSID. The coded character set identifier (CCSID) used when the text description was created using the Change User Print Information (CHGUSRPRTI) command. Possible values are 0 and 1 - 65535, except 65534.
CCSID of job. The coded character set identifier (CCSID) of the job when the spooled file was created. The CCSID specified should represent the contents of the spooled file.
The possible values are:
| 0 | The CCSID is unknown. This value should be used if the CCSID of the contents of data to be spooled is not known. |
| 1-65535, except 65534 | The coded character set identifier of the data to be spooled. |
Channel value array. The array contains 12 channels. Each channel is assigned a number, 1 through 12. Each channel (or number in the array) is assigned a value. That value is the line that the printer skips to before printing starts. For example, if channel 9 had a value of 9, the printer skips to line 9 before printing starts.
When creating a file with data previously spooled and channel values specified, changing the channel values does not affect the newly created spooled file. The channel values used when printing are the ones specified when the data was originally spooled.
Channel mode. A variable indicating the channel value mode.
Possible values are:
| *NORMAL | Use the normal channel values (1 equals skip to line 1, 2 through B equal space one line before printing, C equals skip to overflow line). |
| blank | The channel values specified in the channel value array are used. |
Character code. Whether the coding for the diskette file is in ASCII or EBCDIC form.
Character ID. Whether the character ID can change within the file.
Valid values are Y (yes) or N (no). Set this field to N for all other printer device types.
Character not valid. Whether incorrect character errors are reported. This field is valid only when the printer device type (DEVTYPE) field is *LINE, *AFPDSLINE, or *AFPDS.
Valid values are Y (yes) or N (no). This field is set to N for all other printer device types.
Character set library name. The name of the library containing the font character set object.
The possible values are:
| *CURLIB | The current library is searched for the font character set object. |
| *LIBL | The library list is used to locate the font character set object. |
| library name | This library is searched for the font character set object. |
This field should only be specified for spooled files that contain *AFPDS created on the IBM i operating system. See IBM i-created *AFPDS field.
If this field is not specified for one of these valid types, a default value is used.
Character set name. The name of the font character set
object used to print this file.
The possible values are:
| *FONT | The information specified on the font parameter is used instead of the character set and code page. |
| character set name | The name of the font character set object to use. |
This field should only be specified for spooled files that contain *AFPDS created on the IBM i operating system. See IBM i-created *AFPDS field.
If this field is not specified for one of these valid types, a default value is used.
Character set point size. The point size in which this
spooled file's characters (defined by the character set field) should be
printed.
The possible values are:
| 000.0 | *NONE: The character set does not have a point size. |
| point size | The point size of the character set. The number
must be between 000.1 and 999.9.
This field is ignored if the character set is specified as *FONT. |
This field should only be specified for spooled files that contain *AFPDS created on the IBM i operating system. See IBM i-created *AFPDS field.
If this field is not specified for one of these valid types, a default value is used.
Characters per inch. The number (in tenths) of characters per horizontal inch, defined in the printer file. The value 100 indicates 10 characters per inch. Valid characters per inch include 5, 10, 12, 15, and 16.7. Characters per inch of 13.3, 18, and 20 are valid for double-byte character set devices.
Characters per inch changes. Whether the spooled file changes the characters per inch (cpi) within the file.
For DEVTYPE(*SCS), a Set Character Distance command is contained in the spooled file.
Valid values are Y (yes) or N (no). Set this field to N for all other printer device types.
Code page. The mapping of graphic characters to code points for this printer. For *DEVD, the system gets the code page from the printer device description and this value is ignored. Valid values are 1 through 32767 and *DEVD.
When a numeric value is specified, it is represented as a character string that is right justified with leading zeros.
Code page library name. The name of the library containing
the code page used to print this spooled file.
The possible values are:
| *CURLIB | The current library is searched for the code page name. |
| *LIBL | The library list is used to locate the code page. |
| library name | This library is searched for the code page. |
This field should only be specified for spooled files that contain *AFPDS created on the IBM i operating system. See IBM i-created *AFPDS field.
If this field is not specified for one of these valid types, a default value is used.
Code page name. The name of the code page used to print this spooled file.
This field should only be specified for spooled files that contain *AFPDS created on the IBM i operating system.. See IBM i-created *AFPDS field.
If this field is not specified for one of these valid types, a default value is used.
Coded font array. The name of the fonts used when printing a spooled file with a printer device type (DEVTYPE) of *LINE or *AFPDSLINE. The name does not include the 2-character prefix of the coded font name (X0-XG). This array should be blank for all other printer device types.
Coded font library name. The name of the library containing the coded font used to print this spooled file.
The possible values are:
| *CURLIB | The current library is searched for the coded font. |
| *LIBL | The library list is used to locate the coded font. |
| library name | This library is searched for the coded font. |
This field should only be specified for spooled files that contain *AFPDS created on the IBM i operating system. See IBM i-created *AFPDS field.
If this field is not specified for one of these valid types, a default value is used.
Coded font name. The name of the coded font used to print this spooled file. A coded font is an AFP resource composed of a font character set and a code page.
The possible values are:
| *FNTCHRSET | The values used are the values specified on the character set and code page fields. |
| coded font name | The name of the coded font used to print this spooled file. |
This field should only be specified for spooled files that contain *AFPDS created on the IBM i operating system. See IBM i-created *AFPDS field.
If this field is not specified for one of these valid types, a default value is used.
Coded font point size. The point size in which this spooled
file's characters (defined by the coded font field) should be printed.
The possible values are:
| 000.0 | *NONE: The coded font does not have a point size. |
| point size | The point size of the coded font. The number must
be between 000.1 and 999.9.
This field is ignored if the coded font is specified as *FNTCHRSET. |
This field should only be specified for spooled files that contain *AFPDS created on the IBM i operating system. See IBM i-created *AFPDS field.
If this field is not specified for one of these valid types, a default value is used.
Color. Whether an IPDS Write Text command or AFPDS presentation text data (PTX) structured field containing a Set Text Color control is contained in the spooled file.
For DEVTYPE(*IPDS and *AFPDS), a Set Text Color text control is contained in the spooled file.
Valid values are Y (yes) or N (no). Set this field to N for all other printer device types.
Constant back overlay. Whether or not constant back overlay is used. Constant back allows the user to print overlays on the back side of each sheet of media without the need for the print application to generate blank pages. Specifying the constant back function causes the operating system to generate blank pages onto which the back overlay will be printed. The generated pages are called constant forms because no variable data from the user's print application is printed on the pages. If the multiup field is not set to 1, constant back overlay will be set to *NOCONSTANT. Constant back overlay is ignored if the print on both sides field is set to *NO.
The possible values are:
| 0 | *NOCONSTANT: The constant back overlay function is not used. |
| 1 | *CONSTANT: The constant back overlay function is used. The values for back overlay offset down and back overlay offset across fields are ignored and set to 0.0. |
Control character. Whether the data to be printed used the
American National Standard printer control character.
The possible values are:
| *NONE | No print control characters are passed in the data that is printed. |
| *FCFC | The first character of every record is an American National Standard printer control character. The record length field must include one position for forms control code. This value is not valid for externally described printer files. |
Copies left to produce. The number of copies remaining to be produced on the printer. Valid values are 1 through 255.
CPA3353 message. Whether message CPA3353 is issued when this spooled file is printed.
Valid values are Y (yes) or N (no).
Corner staple. Specifies the reference corner to be used for a corner staple. A staple is driven into the media at the reference corner. Refer to your printer's documentation for information as to which reference corners are supported.
Valid values are:
| 0 | *NONE. A corner staple is not specified. |
| 1 | *DEVD. The default reference corner of the printer device is used. |
| 2 | *BOTRIGHT. The bottom right-hand corner of the paper is specified. |
| 3 | *TOPRIGHT. The top right-hand corner of the paper is specified. |
| 4 | *TOPLEFT. The top left-hand corner of the paper is specified. |
| 5 | *BOTLEFT. The bottom left-hand corner of the paper is specified. |
Data stream size. The number of bytes of data stream for the file.
Date file last used. The date, based on local job time, that the file data was last displayed, copied, printed, or sent; or when the file attributes were last changed. The date is in the CYYMMDD format as follows:
| C | Century, where 0 indicates years 19xx and 1 indicates years 20xx. |
| YY | Year |
| MM | Month |
| DD | Day |
Date file opened (created). The date, based on local job time, that the file was opened in the CYYMMDD format where:
| C | Century, where 0 indicates years 19xx and 1 indicates years 20xx. |
| YY | Year |
| MM | Month |
| DD | Day |
Date writer began processing spooled file. The date, based on local job time, that a spooling writer started processing the spooled file.
Date writer completed processing spooled file. The date, based on local job time, that a spooling writer completed processing the spooled file.
DBCS character rotation. Whether this printer file causes the DBCS characters to be rotated 90 degrees counterclockwise before printing. The possible values are *YES and *NO. This field should be *NO when the DBCS field is *NO.
DBCS character rotation commands. Whether the double-byte character set characters are rotated 90 degrees counterclockwise before printing.
Valid values are Y (yes) or N (no). Set this field to N for all other printer device types.
DBCS characters per inch. The number of double-byte characters to be printed per inch.
The possible values are:
| -1 | *CPI: One-half of the characters-per-inch value. |
| -2 | *CONDENSED: 20 double-byte characters per 3 inches. |
| 5 | 5 characters per inch. |
| 6 | 6 characters per inch. |
| 10 | 10 characters per inch. |
This field should be -1 when the double-byte character set field is *NO.
DBCS-coded font library name. The name of the library containing the DBCS coded font used to print this spooled file.
The possible values are:
| *CURLIB | The current library is searched for the DBCS-coded font. |
| *LIBL | The library list is used to locate the DBCS-coded font. |
| Library name | This library is searched for the DBCS-coded font. |
This field should only be specified on a DBCS system, and only for spooled files that will be created with a device type of *SCS or that will contain IBM i-created *AFPDS. See IBM i-created *AFPDS field.
DBCS-coded font name. Specifies the name of the DBCS-coded font used to print DBCS data on printers configured as AFP(*YES).
The possible values are:
| *SYSVAL | The DBCS-coded font specified in the system value is used. |
| DBCS-coded font name | The name of the DBCS-coded font being used. |
This field should only be specified on a DBCS system, and only for spooled files that will be created with a device type of *SCS or that will contain system-created *AFPDS. See the IBM i-created *AFPDS field.
DBCS-coded font point size. The point size in which this spooled file's DBCS characters (defined by the DBCS-coded font field) should be printed.
The possible values are:
| 000.0 | *NONE: The DBCS-coded font does not have a point size. |
| point size | The point size of the DBCS-coded font. The number must be between 000.1 and 999.9. |
This field is ignored if the DBCS-coded font is specified as *SYSVAL.
This field should only be specified on a DBCS system, and only for spooled files that will be created with a device type of *SCS or that will contain system-created *AFPDS. See the IBM i-created *AFPDS field.
DBCS data. Whether this spooled file contains double-byte character set (DBCS) data, UCS-2 data, or both. The options are *YES or *NO. The other DBCS fields should also be set appropriately.
DBCS extension characters. Whether the system is to use the extension character processing function for DBCS data.
The possible values are:
| *YES | The system processes DBCS extension characters. |
| *NO | The system does not process DBCS extension characters; it prints extension characters as the undefined character. |
This field should be *NO when the DBCS data field is *NO.
DBCS shift-out shift-in (SO/SI) spacing. The presentation of shift-out and shift-in characters when printed.
The possible values are:
| *YES | Shift-out and shift-in characters occupy one space. |
| *NO | Shift-out and shift-in characters occupy no space. |
| *RIGHT | Shift-out characters occupy no space and shift-in characters occupy two spaces. |
This field should be *NO when the DBCS data field is *NO.
DDS. Whether the file was constructed with DDS.
Valid values are Y (yes) or N (no). This field should be set to N when the file contains data that has not been spooled before.
Decimal format. Whether the decimal format that is used is from the printer file or from the job attribute when the spooled file is generated. The possible values are *FILE and *JOB. *FILE indicates that the decimal format stored in the printer file when the printer file was created is used. *JOB indicates that the decimal format from the DECFMT job attribute is used.
Define characters. Whether the spooled file defines or redefines unique print characters.
For DEVTYPE(*SCS), a Load Alternate Characters command is contained in the spooled file.
Valid values are Y (yes) or N (no). Set this field to N for all other printer device types.
Device file library name. The name of the library that contains the device file. The device file name must also be specified.
Device file name. The name of the device file used to create the spooled file. The device file library name must also be specified.
Device type. The type of device file for which this file is intended. The possible values are PRINTER, DISKETTE, or TAPE.
Document name. The name of the document that was the source of the spooled file. This field is used by the OfficeVision program and must be blank for other spooled files. If the document name is specified, the folder name must also be specified.
Double-wide characters. Whether the spooled file prints everything twice as wide as normal.
Drawer change. Whether the printer drawer is changed within the spooled file.
Valid values are Y (yes) or N (no). Set this field to N for all other printer device types.
Edge-stitch number of staples. Specifies the number of staples that are to be applied along the finishing margin.
Valid values are:
| 0 | *DEVD. Use the device default. Specify this value if:
|
| 1-122 | Number of staples to be used in the edge-stitch. The number of edge-stitch staple offset entries field must be zero (*DEVD). |
An edge-stitch or saddle-stitch consists of one or more staples driven into the media along a finishing margin. Refer to your printer's documentation for information about whether this field is supported and what values for this field are supported. If this field is not supported, specify a value of *DEVD.
Edge-stitch reference edge. Specifies the edge of the paper to be used as a reference in determining where the edge stitching is to be located.
Valid values are:
| 0 | *NONE. An edge stitch is not specified. |
| 1 | *DEVD. The default reference edge used by the printer device is specified. |
| 2 | *BOT. The bottom edge of the paper is specified. |
| 3 | *RIGHT. The right-hand edge of the paper is specified. |
| 4 | *TOP. The top edge of the paper is specified. |
| 5 | *LEFT. The left-hand edge of the paper is specified. |
An edge-stitch or saddle-stitch consists of one or more staples driven into the media along a finishing margin. Refer to your printer's documentation for information about whether this field is supported and what values for this field are supported. If this field is not supported, specify a value of *DEVD.
Edge-stitch staple offset. The offset from the beginning of this format to the list of the edge-stitch staple offsets section (for more details, see Edge-Stitch Staple Offset Entry).
An edge-stitch or saddle-stitch consists of one or more staples driven into the media along a finishing margin. Refer to your printer's documentation for information about whether this field is supported and what values for this field are supported. If this field is not supported, specify a value of *DEVD.
Ending page. The page at which printing is to end for the spooled file.
0 or 2147483647 indicates the last page. To print the entire spooled file, set this value to 0, 2147483647, or the last page number.
Exchange type. The exchange type of the diskette file.
The possible values are:
| *STD | The system allows the exchange type based on the diskette type and sector size. |
| *BASIC | The basic exchange type. |
| *H | The H exchange type. |
| *I | The I exchange type. |
Expiration date. The date the file will be eligible for removal from the system by the Delete Expired Spooled Files (DLTEXPSPLF) command and blank if the file will not expire. The spooled file will expire at 23:59:59, local system time on the date specified. The date is in the CYYMMDD format as follows:
| C | Century, where 0 indicates years 19xx and 1 indicates years 20xx. |
| YY | Year |
| MM | Month |
| DD | Day |
Extended code page. Whether the extended code page changes within the file.
Valid values are Y (yes) or N (no).
FFT emphasis. Whether the spooled file contains text that is to appear darker than the surrounding text.
For DEVTYPE(*SCS), Begin Emphasis and End Emphasis commands are contained in the spooled file.
Valid values are Y (yes) or N (no). Set this field to N for all other printer device types.
Field outlining. Whether the spooled file outlines fields of data with boxes. If it does, the file must be printed on a printer that supports field outlining.
For DEVTYPE(*SCS), a Define Grid Line command is contained in the spooled file.
Valid values are Y (yes) or N (no). Set this field to N for all other printer device types.
File available. The time this spooled file becomes available to an output device for processing.
The possible values are:
| *IMMED | The spooled file is available as soon as it is opened. |
| *FILEEND | The spooled file is available as soon as it is closed. |
| *JOBEND | The spooled file is available when the job that
created it has completed.
When *JOBEND is specified and the spooled file is being created for another user, the value is changed to *FILEEND because the job it is assigned to is the special system job QPRTJOB. When a value is not one of the three listed, the default used is *FILEEND. In this case the default is not taken from the device file specified. |
File label identifier. The diskette label used when the system last saved the object.
File open. Whether the spooled file is still open when the fields are retrieved. If fields retrieved from an open spooled file are used to create a new spooled file, the create operation fails. Changing this flag to N for a spooled file that is open could cause unpredictable results in a newly created spooled file.
File stopped on page boundary. Whether the spooled file stops on a page boundary.
Valid values are Y (yes) or N (no). If the spooled file has not been sent to a printer, set the field to N.
Final form feed. Whether the Final Form Feed command is in the printer file.
Valid values are Y (yes) or N (no).
Final form text. Whether this spooled file contains various functions that are supported on letter-quality printers.
Valid values are Y (yes) or N (no). Set this field to N for all other printer device types.
Fold records. Whether all positions in a record are displayed.
The possible values are:
| *YES | Records whose length exceeds the page width flow to the following line. |
| *NO | Records whose length exceeds the page width are truncated. |
Folder name. The name of the folder that contains the document name. This field is used by the OfficeVision program and must be blank for other spooled files. If the folder name is specified, the document name must also be specified.
Font. Whether the spooled file uses multiple fonts.
Valid values are Y (yes) or N (no). Set this field to N for all other printer device types.
Font equivalence array. The data portion of the Load Font Equivalence (LFE) command for intelligent printer data streams (IPDS). The current maximum is 48. However, for future expansion, the array returns 72 sixteen-character font equivalences. To support that further expansion, the 1153rd character of the variable is set to 1 when more than 72 entries are available. The format of this entry is described in the IPDS Reference.
Font resolution for formatting. The resolution Print Services Facility/400 (PSF/400) should use to print the spooled file when printing to a multiple resolution printer and either of the following conditions exist:
The possible values are:
| *DEVD | PSF/400 is to use the value specified on the font resolution for formatting parameter in the PSF configuration object. The PSF configuration object is specified in the printer device description. |
| *SEARCH | PSF/400 is to search for a font that will work. The search method is outlined in the Printing topic. |
| 240 | PSF/400 is to use only fonts that are 240 pels per inch. |
| 300 | PSF/400 is to use only fonts that are 300 pels per inch. |
Form definition library name. The name of the library that contains the form definition. The special value *LIBL should be specified when the form definition name field is specified as *DEVD.
This field should only be specified for spooled files with device types of *USERASCII, *LINE, *AFPDSLINE, *SCS, *IPDS, or *AFPDS if the spooled file was not created on a System i platform. See IBM i-created *AFPDS field.
If this field is not specified for one of these valid types, a default value is used.
Form definition name. The name of the form definition to use for printing the spooled file.
The possible values are:
| *DEVD | The form definition in the printer device description is used. This is the default value. |
| *INLINE | The form definition defined in the spooled file data stream is used. |
| *INLINED | The form definition defined in the spooled file data stream is used. If a form definition is not found, the form definition in the printer device description is used. |
| F1DFLT | The form definition defined in the spooled file data stream is used. F1DFLT is the in-line form definition built by the IBM i operating system for spooled files of printer device type *AFPDS. When the field IBM i-created AFPDS is set to 'Y', the form definition library name field must be set to blanks. |
| form definition name | The name of the form definition. |
This field should only be specified for spooled files with device types of *USERASCII, *LINE, *AFPDSLINE, *SCS, *IPDS, or *AFPDS if the spooled file was not created on a System i platform. See IBM i-created *AFPDS field.
If this field is not specified for one of these valid types, a default value is used.
Form feed. The form feed attachment used by the printer device file.
The possible values are:
| *DEVD | The forms are fed into the printer as described in the device description. |
| *CONT | Continuous forms are used by the printer. The tractor-feed attachment must be put on the printer if this value is specified. |
| *CUT | Single-cut sheets are used by the printer. Each sheet is manually loaded. The forms alignment message is not sent for cut sheets. |
| *AUTOCUT | Single-cut sheets are semiautomatically fed into the printer. The sheet-feed attachment must be put on the printer if this value is specified. The forms alignment message is not sent for cut sheets. |
| *CONT2 | Secondary continuous forms are used by the printer. The secondary tractor-feed attachment must be put on the printer if this value is specified. |
Form type. The type of form loaded in the printer to print the spooled file.
Format name. The name of the format of the fields. The only accepted value is SPLA0200.
Front margin offset across. For the front side of a piece of paper it, specifies, in either inches or centimeters (specified in the unit of measure (UOM) parameter), how far in from the left side of the page printing starts.
The possible values are:
| 0-57.79 | The offset in inches or centimeters, according to the unit of measure field. The maximum offset is 57.79 centimeters or 22.75 inches. |
This field should only be specified for spooled files with device types of *LINE, *AFPDSLINE, or *AFPDS if the spooled file was created on a System i platform. See IBM i-created *AFPDS field.
If this field is not specified for one of these valid types, a default value is used.
Front margin offset down. For the front side of a piece of paper, it specifies, in either inches or centimeters (specified in the unit of measure (UOM) parameter), how far down from the top of the page printing starts.
The possible values are:
| -2 | *DEVD. For printers configured AFP(*YES), no print border is used for front margin offsets across and down. Otherwise, the offset values are 0. |
| 0-57.79 | The offset in inches or centimeters, according to the unit of measure field. The maximum offset is 57.79 centimeters or 22.75 inches. |
This field should only be specified for spooled files with device types of *LINE, *AFPDSLINE, or *AFPDS if the spooled file was created on a System i platform. See IBM i-created *AFPDS field.
If this field is not specified for one of these valid types, a default value is used.
Front overlay library name. The name of the library containing the front overlay.
The possible values are:
| *CURLIB | The current library for the job locates the front overlay. |
| *LIBL | The library list locates the front overlay. |
| library name | This library is searched for the front overlay. |
This field should only be specified for spooled files with device types of *SCS, *IPDS, or *AFPDS if the spooled file was created on a System i platform. See IBM i-created *AFPDS field.
If this field is not specified for one of these valid types, a default value is used.
Front overlay name. The name of the front overlay (the material that prints on the front side of each page).
The possible values are:
| *NONE | The file does not use the front overlay. |
| front overlay name | The name of the front overlay. |
If an overlay name is specified, the front overlay library name must also be specified.
This field should only be specified for spooled files with device types of *SCS, *IPDS, or *AFPDS if the spooled file was created on a System i platform. See IBM i-created *AFPDS field.
If this field is not specified for one of these valid types, a default value is used.
Front overlay offset across. The offset across from the point of origin where the overlay is printed.
The possible values are:
| 0-57.79 | The offset in inches or centimeters, according to the unit of measure field. The maximum offset is 57.79 centimeters or 22.75 inches. |
This field should only be specified for spooled files with device types of *SCS, *IPDS, or *AFPDS if the spooled file was created on a System i platform. See IBM i-created *AFPDS field.
If this field is not specified for one of these valid types, a default value is used.
Front overlay offset down. The offset down from the point of origin where the overlay is printed.
The possible values are:
| 0-57.79 | The offset in inches or centimeters, according to the unit of measure field. The maximum offset is 57.79 centimeters or 22.75 inches. |
This field should only be specified for spooled files with device types of *SCS, *IPDS, or *AFPDS if the spooled file was created on a System i platform. See IBM i-created *AFPDS field.
If this field is not specified for one of these valid types, a default value is used.
Graphic character set. The set of graphic characters used when printing the spooled file. For *DEVD, the system gets the graphic character set from the printer device description. Valid values are 1 through 32767 and *DEVD.
When a numeric value is specified, it is represented as a character string that is right-justified with leading zeros.
Graphics. Whether the spooled file contains graphics commands in its data stream.
Valid values are Y (yes) or N (no).
Graphics error actions. Whether the file contains graphic error action commands.
For SCS files, the file contains one or more Set Graphic Error Action commands.
Valid values are Y (yes) or N (no). Set this field to N for all other printer device types.
Graphics token. The printer type on which the graphics in the spooled file can be printed.
The possible values are:
| 4214 | Data stream contains graphics for a 4214 printer. |
| 4234 | Data stream contains graphics for a 4234 printer. |
| 522X | Data stream contains graphics for a 522x printer. |
| IPDS | Data stream contains graphics for an IPDS printer. |
Group level index tags. For DEVTYPE(*AFPDS), whether there are index tags at the group level. Set the field to N for all other printer device types.
Height of drawer 1. The height in inches of the paper in drawer 1. This field is set to packed 0 when the spooled file is being created as opposed to being copied. All other drawer fields should also be set to packed 0.
Height of drawer 2. The height in inches of the paper in drawer 2. This field is set to packed 0 when the spooled file is being created as opposed to being copied. All other drawer fields should also be set to packed 0.
Highlight. Whether the spooled file contains text that is to appear darker than the surrounding text.
Valid values are Y (yes) or N (no). Set this field to N for all other printer device types.
Hold file before written. Whether the spooled file is to be held.
The possible values are:
| *YES | The file is held. |
| *NO | The file is not held. |
Internal job identifier. The internal identifier for the job. Only the IBM i APIs use this identifier, not any other interface on the system. The identifier is not valid following an initial program load (IPL). If you attempt to use it after an IPL, an exception occurs.
Internal spooled file identifier. The value used as input to other programs to improve the performance of locating the spooled file on the system. Only the IBM i APIs use this identifier, not any other interface on the system. The identifier is not valid following an initial program load (IPL) or if the spooled file has been moved between auxiliary storage pools (ASPs). If you attempt to use an invalid internal spooled file identifier, an exception occurs.
Internet print protocol job identifier. The offset from the beginning of this format to the Internet print protocol spooled file attributes section.
IPDS pass-through. Specifies whether IPDS pass-through is done for the spooled file.
Valid values are:
| 0 | *DEVD. The value specified for the IPDS pass-through (IPDSPASTHR) parameter in the PSF configuration object will be used. The PSF configuration object is specified in the printer device description. |
| 1 | *NO. No IPDS pass-through is done. |
| 2 | *YES. IPDS pass-through is to be done if the spooled file is eligible for IPDS pass-through. |
Not all SCS or IPDS spooled files are eligible for IPDS pass-through. They may contain special functions that require transform to AFPDS for correct printing. If you specify IPDS pass-through on the printer file, only those spooled files eligible for IPDS pass-through bypass the extra transforms. Those spooled files not eligible for IPDS pass-through will still undergo the transforms to AFPDS and back to IPDS.
IPDS pass-through will not be valid for all PSF/400 supported printers. Any printer (or attachment) that does not support resident fonts cannot support IPDS pass-through. This is because the resident font references in the data stream must be mapped to host fonts that are downloaded to the printer. All IBM® IPDS printers, except for the following, can be supported with IPDS pass-through: 3820, 3825, 3827, 3828, 3829, 3831, 3835, 3900-001 and any printer attached using Print Services Facility™ for the OS/2® distributed print function.
IPDS transparent data. Whether the file contains data from System/36 Programming Request for Price Quotations (PRPQs).
Valid values are Y (yes) or N (no). This field should be set to N when creating a spooled file as opposed to copying an existing spooled file.
Job character ID specified. Whether the graphic character set and code page of the spooled file is taken from the coded character set identifier (CCSID) of the job. The possible values are Y or N.
Job name. The name of the job that owns the spooled file.
Job number. The number of the job that owns the spooled file.
Job system name. The name of the system where the job that created the spooled file ran.
Justification. The percentage that the output is right-justified. The values are 100, 50, or 0.
Last page printed. The number of the last printed page in the file if printing ended before the job completed processing.
Length of each user-defined option entry. The length, in bytes, of each user-defined option entry.
Length of page. The length of a page in rows and columns (*ROWCOL) or in inches and centimeters (*UOM).
If this field is specified and the measurement method used is *ROWCOL, this value should be the same as that specified on the page length field found in this format.
If this field is specified and the measurement method is *UOM, the actual distance specified must be equivalent to that specified on the page length field found in this format.
If the measurement method is *ROWCOL, the page length value must be from 1 through 255. If the measurement method is *UOM, the page length value must be between 0 and 57.79.
Length of edge-stitch staple offset entry. The size of each entry in the list. This should always be set to 8 when the number of staple offset entries is not zero.
An edge-stitch or saddle-stitch consists of one or more staples driven into the media along a finishing margin. Refer to your printer's documentation for information about whether this field is supported and what values for this field are supported. If this field is not supported, specify a value of *DEVD.
Length of library list entry. If you need resources to be used with the new spooled file, they must be in libraries contained in your library list at spooled file creation time.
Length of saddle-stitch staple offset entry. The size of each entry in the list. This should always be set to 8 when the number of staple offset entries is not zero.
An edge-stitch or saddle-stitch consists of one or more staples driven into the media along a finishing margin. Refer to your printer's documentation for information about whether this field is supported and what values for this field are supported. If this field is not supported, specify a value of *DEVD.
Length of user resource library list entry. The size of each entry in the list. This should always be set to 10 when the user resource library list number is not zero.
Lengths present. Whether the 8-byte length information is present in the print text data buffers for format SPLF0200. This field is valid when the printer device type (DEVTYPE) field is *AFPDS, *AFPDSLINE, or *LINE.
Valid values are Y (yes) or N (no). It must be set to Y for *AFPDSLINE and *LINE printer device types. *AFPDS data may or may not have the length information. This field should be set to N for all other printer device types.
Line spacing. How a spooled file's line data records are spaced when printed. This information is necessary only when the printer device type (DEVTYPE) parameter on the printer file is *LINE or *AFPDSLINE.
The possible values are:
| *SINGLE | The printed output is single spaced. If the data contains control characters, they are ignored. |
| *DOUBLE | The printed output is double spaced. If the data contains control characters, they are ignored. |
| *TRIPLE | The printed output is triple spaced. If the data contains control characters, they are ignored. |
| *CTLCHAR | The control characters in the data determine the line spacing. This value should be used when the printer device type is not *LINE or *AFPDSLINE. |
Lines per inch. The number (in tenths) of lines per vertical inch defined in the printer file. The value 40 indicates 4 lines per inch. Valid lines per inch include 4, 6, 8, 9, and 12. Lines per inch of 3 and 7.5 are valid for double-byte character set devices.
Lines per inch changes. Whether the lines per inch (lpi) changes within the spooled file.
Valid values are Y (yes) or N (no). Set this field to N for all other printer device types.
Lines-per-inch (lpi) value not supported. Lines-per-inch (lpi) value not supported.
Maximum forms width. The maximum width of printer file forms in character positions.
Maximum records. The maximum number of records allowed in the spooled file when it is opened. Valid values are 1 through 999999. A special value of 0 indicates *NOMAX.
Maximum spooled data record size. The length of the largest record in the spooled file. For DEVTYPE *LINE, *AFPDSLINE, and *AFPDS spooled files, this length is the length of the largest record in the spooled file. For all other printer device types (DEVTYPE), this length is the same as the spooled file buffer size.
Measurement method. The measurement method used for the length of page and width of page fields.
The possible values are:
| *ROWCOL | Uses rows and columns as the units of measure. |
| *UOM | Uses the value specified on the unit of measurement parameter (UOM). UOM is either inches (*INCH) or centimeters (*CM). |
Multiple up (pages per side). The number of logical pages that print on each side of each physical page when this spooled file prints. The possible values are 1, 2, 3, and 4.
This field should only be specified for spooled files with device types of *SCS, *IPDS, or *AFPDS if the spooled file was created on a System i platform. See IBM i-created *AFPDS field.
If this field is not specified for one of these valid types, a default value is used.
Net ID where file originated. the Net ID where the file originated.
Number of buffers. The number of buffers in the spooled file.
Number of edge-stitch staple offset entries. The number of
staple offset entries.
Valid values are:
| 0 | *DEVD. Use the device default. Specify this value
if either of the following is specified:
|
| 1-122 | The number of staple offset entries. The edge-stitch number of staples field must be set to *DEVD. |
This field specifies the placement of staples along the finishing margin in either inches or centimeters (specified in the unit of measure field). The finishing margin can be thought of as an imaginary line parallel to the edge of the paper where the staples will be placed. The position of the finishing margin relative to the physical edge is specified in the offset from edge-stitch reference edge field.
If you want the staples placed along the left or right edge of the paper, specify the offset of the first staple by measuring from the point where the finishing margin intersects the bottom edge of the paper to where you want the center of the staple to be. For subsequent staples, specify the offset by measuring from the same point (not from the previous staple).
If you want the staples placed along the top or bottom edge of the paper, specify the offset of the first staple by measuring from the point where the finishing margin intersects the left edge of the paper to where you want the center of the staple to be. For subsequent staples, specify the offset by measuring from the same point (not from the previous staple). The possible values for each staple offset are:
| 0-57.79 | The offset in inches or centimeters, according to the Unit of measure value. The maximum offset is 57.79 centimeters or 22.75 inches. |
An edge-stitch or saddle-stitch consists of one or more staples driven into the media along a finishing margin. Refer to your printer's documentation for information about whether this field is supported and what values for this field are supported. If this field is not supported, specify a value of *DEVD.
Number of font array entries. The number of font equivalence array entries used. The valid values for the field are 0 through 48, where 0 indicates that there are no entries in the array. The field is valid only for spooled files that have the printer device type field equal to *IPDS. It should be set to zero for all other printer device types.
Number of library list entries. If you need resources to be used with the new spooled file, they must be in libraries contained in your library list at spooled file creation time.
Number of resource library entries. The number of entries in the resource library array used.
Number of saddle-stitch staple offset entries. The number of staple offset entries.
Valid values are:
| 0 | *DEVD. Use the device default. Specify this value
either of the following is specified:
|
| 1-122 | The number of staple offset entries. The saddle-stitch number of staples field must be set to *DEVD. |
This field specifies the placement of staples along the finishing margin in either inches or centimeters (specified in the unit of measure field). The finishing margin can be thought of as an imaginary line parallel to the edge of the paper where the staples will be placed. The position of the finishing margin is the center of the paper relative to the physical edge.
If you want the staples placed parallel to the left edge of the paper, specify the offset of the first staple by measuring from the point where the finishing margin intersects the bottom edge of the paper to where you want the center of the staple to be. For subsequent staples, specify the offset by measuring from the same point (not from the previous staple).
If you want the staples placed parallel to the top edge of the paper, specify the offset of the first staple by measuring from the point where the finishing margin intersects the left edge of the paper to where you want the center of the staple to be. For subsequent staples, specify the offset by measuring from the same point (not from the previous staple).
The possible values for each staple offset are:
| 0-57.79 | The offset in inches or centimeters, according to the Unit of measure value. The maximum offset is 57.79 centimeters or 22.75 inches. |
An edge-stitch or saddle-stitch consists of one or more staples driven into the media along a finishing margin. Refer to your printer's documentation for information about whether this field is supported and what values for this field are supported. If this field is not supported, specify a value of *DEVD.
Number of separators. The number of file separator pages placed at the beginning of each copy. Valid values are 0 through 9, with 0 meaning no separator pages.
Number of user-defined options returned. The number of user-defined option entries. Each entry contains one user-defined option.
Valid values are:
| 0 | No user-defined options are specified. |
| 1-4 | The number of user-defined options specified. |
Number of user resource library list entries. The number of user resource library list entries.
Valid values are:
Each entry contains one user resource library.
| -1 | *DEVD. The user resource library list in the PSF configuration object specified in the printer device description is to be used to search for AFP resources. If there is no PSF configuration object, then the spooled file's library list is to be used to search for AFP resources. |
| -2 | *JOBLIBL. The spooled file's library list will be used to search for AFP resources. |
| -3 | *CURLIB. The current library for the job that created the spool file is used to search for AFP resources. If no library is specified as the current library for the job, then library QGPL is used. |
| 0 | *NONE. There is no user resource library list to be used to search for AFP resources. |
| 1-4 | Number of user resource libraries. |
OfficeVision. Whether the spooled file is generated by the OfficeVision licensed program.
Valid values are Y (yes) or N (no). This field should be set to N when creating a spooled file as opposed to copying an existing spooled file.
Offset from edge-stitch reference edge. Specifies, in either inches or centimeters (specified in the units of measure field), how far from the edge-stitch reference edge that the edge-stitch is to be placed.
The possible values are:
| -1.0 | *DEVD. The default edge-stitch offset of the printer device is specified. |
| 0-57.79 | The offset in inches or centimeters, according to the Unit of measure value. The maximum offset is 57.79 centimeters or 22.75 inches. |
An edge-stitch or saddle-stitch consists of one or more staples driven into the media along a finishing margin. Refer to your printer's documentation for information about whether this field is supported and what values for this field are supported. If this field is not supported, specify a value of *DEVD.
Offset to edge-stitch staple offset list. The offset to the information about each staple offset entry. Each entry contains the staple offset for that staple.
Offset to IPP attributes. The offset to the IPP specific spooled file attributes. This value is set to 0 if the spooled file was not create through IPP.
Offset to library list. If you need resources to be used with the new spooled file, they must be in libraries contained in your library list at spooled file creation time.
Offset to saddle-stitch staple offset list. The offset from the beginning of this format to the list of the saddle-stitch staple offsets section (for more details, see Saddle-Stitch Staple Offset Entry).
An edge-stitch or saddle-stitch consists of one or more staples driven into the media along a finishing margin. Refer to your printer's documentation for information about whether this field is supported and what values for this field are supported. If this field is not supported, specify a value of *DEVD.
Offset to Save and Restore spooled file attributes. The offset to the save and restore specific spooled file attributes.
Offset to user-defined options. The offset from the beginning of this format to the list of the user-defined options section (for more details, see User-Defined Option Entry).
Offset to user resource library list. The offset from the beginning of this format to the list of user resource library list section (for more details, see User Resource Library List Entry).
IBM i-created AFPDS. Whether the spooled file contains AFPDS data created on i5/OS. Valid values are Y (yes) or N (no).
Output bin. The output bin the printer uses for the printed output.
The possible values are:
| 0 | *DEVD: The default output bin of the printer is used. |
| Output bin | The number of the output bin specified. The number must be between 1 and 65535. |
Output priority. The priority of the spooled file. The priority ranges from 1 (highest) to 9 (lowest). The priority specified must be within the limits of the owner of the spooled file. The limit can be found by using the Retrieve User Information (QSYRUSRI) API or the Retrieve User Profile (RTVUSRPRF) command, specifying the PTYLMT parameter.
Output queue library name. The name of the library that contains the output queue. The OUTQLIB parameter on the RTVUSRPRF can be used to retrieve the library name. A blank library name defaults to *LIBL.
Output queue name. The name of the output queue where the new spooled file is placed. If the output queue specified in the user profile for the owner of the spooled file is to be used, the Retrieve User Profile (RTVUSRPRF) command or the Retrieve User Profile (RTVUSRPRF) API can be used, specifying the OUTQ parameter. A blank output queue name defaults to the printer file.
Overflow line number. The last line to be printed before the data being printed overflows to the next page. Valid values are 1 through 255. This value cannot be greater than the value specified in the page length field.
Page count estimated. Whether the total pages given is an estimate.
Valid values are Y (yes) or N (no).
The total page count is estimated in the following situations:
Page definition library name. The name of the library in which the page definition resides. This information is necessary only when the printer device type (DEVTYPE) parameter is *LINE, *AFPDSLINE, or *USERASCII.
Page definition name. The name of the page definition to use for the spooled file. This information is used only when the printer device type (DEVTYPE) parameter is *LINE, *AFPDSLINE, or *USERASCII. The special value of *NONE indicates no page definition. When a page definition name is specified, the page definition library name must also be specified.
Page groups. For DEVTYPE(*AFPDS), whether there are page groups in the spooled file. Set the field to N for all other printer device types.
Page length. The page length (in lines per page) used by the spooled file specified in the device file field. The valid range is row 1 through 255. The value should not exceed the actual length of the page.
Page level index tags. For DEVTYPE(*AFPDS), whether there are index tags at the page level. Set the field to N for all other printer device types.
Page or record being written. The page number or record number currently being written. The page number may be lower or higher than the page number actually being printed because of buffering done by the system. The page number shown may be zero if:
Page position. Whether page positioning errors are reported.
Valid values are Y (yes) or N (no).
Page rotate. Whether the spooled file changes the page rotation to be used within the file.
.Valid values are Y (yes) or N (no). Set this field to N for all other printer device types.
Page rotation. The degree of rotation of the text on the page, with respect to the way the form is loaded into the printer.
The possible values are:
| -1 | *AUTO: Computer output reduction is done automatically if the output is too large to fit on the form, regardless of the print quality. |
| -2 | *DEVD: Page rotation is obtained from the printer device description. |
| -3 | *COR: Output created for a form 13.2 inches wide by 11.0 inches long is adjusted to print on a form 11.0 inches wide by 8.5 inches long. |
| 0 | No rotation is done. Printing starts at the edge of the paper loaded into the printer first and is parallel to that edge. |
| 90 | Text is rotated 90 degrees clockwise from the 0-degree writing position. |
| 180 | Text is rotated 180 degrees clockwise from the 0-degree writing position. |
| 270 | Text is rotated 270 degrees clockwise from the 0-degree writing position. |
Page width. The page width (in characters per printed line) used by the spooled file specified in the device file field. The valid range is column 1 through 378, although some printers have a page width less than 378. The value should not exceed the actual width of the page used.
Point size. The point size in which this spooled file's characters (defined by the printer font field) should be printed. Valid values are 000.1 through 999.9. This field is ignored if the Printer font is specified as 0.0 (*DEVD).
Print fidelity. The kind of error handling that is performed when printing spooled files with a printer device type of *AFPDS.
The possible values are:
| *CONTENT | The printing overrides errors in the data stream and continues printing with the printers best quality based on the content fidelity. |
| *ABSOLUTE | The spooled file is printed exactly as intended. Printing is stopped if an error is encountered in the data stream. |
This field should be set to *CONTENT for all non-AFPDS files.
Print on both sides (duplex). How the information prints.
The possible values are:
| *FORMDF | A user-specified form definition determines how printing is done. This value is used only when the printer device type (on the printer file) is specified as *LINE, *AFPDS, *SCS, *IPDS, or *AFPDSLINE. |
| *NO | The print appears on only one side of a piece of paper. |
| *YES | The print is on both sides of the page with the top of each page the same for both sides. |
| *TUMBLE | The print is on both sides of the page with the top of one printed page at the opposite end from the top of the other printed page. |
Print quality. The print quality used when printing the data.
The possible values are:
| *STD | Standard |
| *DRAFT | Draft |
| *NLQ | Near-letter quality |
| *FASTDRAFT | Pages printed per minute are greater than if *DRAFT is specified. |
Print text. The text that is printed on separator pages. Print text in the print data stream is not changed.
Printer device type. The type of data stream used to represent the spooled file.
The possible values are:
| *AFPDS | Advanced Function Presentation data stream |
| *AFPDSLINE | AFPDS data mixed with 1403 line data |
| *IPDS | Intelligent printer data stream |
| *LINE | 1403 line data |
| *SCS | Systems Network Architecture (SNA) character stream |
| *USERACSII | ASCII data |
The data stream of the spooled file must correspond to the printer device type.
Printer font. The printer font that is used.
The possible values are:
| *DEVD | The font defined in the printer device description. |
| *CPI | A font that has the pitch specified by the characters-per-inch field. |
| identifier | The numeric font identifier that is used with the printer device file. The font specified should be valid for the printer. |
Program that opened file library name. The name of the library that contains the program that opened the file.
Program that opened file name. The name of the program that opened the spooled file.
Record format. The format of the records in the spooled file.
The possible values are:
| *FIXED | All records in the spooled file are the same size; that is, the original length specified in the print data for each record is the same for all records. |
| *VARIABLE | Records in the spooled file vary in size; that
is, the original length specified in the print data for each record has at
least one different value for records in the spooled file.
For DEVTYPE *USERASCII, *IPDS, and *SCS without ASCII data files are all fixed format. *SCS files with ASCII data are variable length. For DEVTYPE *AFPDS, *AFPDSLINE, and *LINE, data files can be either fixed or variable. |
Record format name present in data stream. Whether a record format name exists in columns 1 - 10 of a line data record or columns 2 - 11 if the spooled file contains carriage control characters.
For DEVTYPE(*LINE and *AFPDSLINE), record formats in a page definition could be used. The possible values are Y or N.
Valid values are Y (yes) or N (no). Set this field to N for all other printer device types.
Record length. The length of spooled file records. If the field shows -1 (the special value *RCDFMT), this is an externally defined spooled file, and the length is included in the spooled file definition. The length includes the extra length of 1 for carriage control if it exists.
Reduce output. The manner in which multiple logical pages print on each side of a physical page.
The possible values are:
| *TEXT | A smaller font and lpi are used to print multiple logical pages on each side of a physical page. The smaller font and lpi preserves the contents of each logical page. The possible values for the multiple up parameter are 1, 2, and 4. |
| *NONE | The printer prints multiple logical pages on each side of each physical page. There are no changes to the fonts and lpi values used in each logical page. The possible values for the multiple up parameter are 1, 2, 3, and 4. |
Replace unprintable characters. Whether characters that cannot be printed are to be replaced with another character.
Valid values are Y (yes) or N (no).
Replacement character. The character that replaces any unprintable characters. This field has a value if the replace unprintable characters field specifies Y.
Reserved. The field is reserved.
Resource library array. If you need resources to be used with the new spooled file, they must be in libraries contained in your library list at spooled file creation time.
Restart printing. The number of the page where printing is restarted.
The possible values are:
| -1 | *STRPAGE: The page specified in the starting page field. |
| -2 | *ENDPAGE: The last page. |
| restart page | The page number where printing is restarted. This number should be within the page range specified by the spooled file starting and ending page field. |
Saddle-stitch number of staples. The number of staples that are to be applied along the finishing margin.
Valid values are:
| 0 | *DEVD. Use the device default.
Specify this value if:
|
| 1-122 | Number of staples to be used in the saddle-stitch. The number of saddle-stitch staple offset entries field must be zero (*DEVD). |
An edge-stitch or saddle-stitch consists of one or more staples driven into the media along a finishing margin. Refer to your printer's documentation for information about whether this field is supported and what values for this field are supported. If this field is not supported, specify a value of *DEVD.
Saddle-stitch reference edge. The edge of the paper to be used as a reference in determining where the saddle stitching is to be located.
Valid values are:
| 0 | *NONE. Saddle stitch is not specified. |
| 1 | *DEVD. The default reference edge used by the printer device is specified. |
| 2 | *TOP. The top edge of the paper is specified. |
| 3 | *LEFT. The left-hand edge of the paper is specified. |
An edge-stitch or saddle-stitch consists of one or more staples driven into the media along a finishing margin. Refer to your printer's documentation for information about whether this field is supported and what values for this field are supported. If this field is not supported, specify a value of *DEVD.
Save file after written. Whether the spooled file is saved after it is written.
The possible values are:
| *YES | Save the spooled file. |
| *NO | Do not save the spooled file. |
SCS data. Whether the spooled file is created with SCS already in the input data.
Valid values are Y (yes) or N (no).
Set exception. Whether the spooled file has the SCS Set Exception Action command in the data stream.
Valid values are Y (yes) or N (no).
Set Line Density command. Whether the lines per inch (lpi) changes within the spooled file or is specified with the Set Line Density SCS command.
For DEVTYPE(*SCS), a Set Line Density command is contained in the spooled file.
Valid values are Y (yes) or N (no). Set this field to N for all other printer device types.
Source drawer. The drawer to be used when the form feed field is set to *AUTOCUT.
The possible values are:
| 1-255 | The drawer number. |
| -1 | *E1, the envelope drawer. |
| -2 | *FORMDF, indicating that the file uses a user-specified form definition. This value is used only when the printer device type (DEVTYPE) field has been set to *LINE, *AFPDS, or *AFPDSLINE. |
Spooled file buffer size. The length of the buffer being written. Sizes supported are 512 and 4079. A buffer size of 512 is recommended for spooled files that have a schedule field of *IMMED. A buffer size of 4079 is recommended for spooled files that have a schedule field of *FILEEND or *JOBEND. If the original spooled file was spooled with a buffer size of 4079, changing the buffer size to 512 causes a function check to occur.
Spooled file creation authentication method. The authentication method used when creating the spooled file.
| 0 | *NONE No authentication method was used. |
| 1 | *REQUESTER The requesting user was used to authenticate the request. |
| 2 | *BASIC The client requested the user to sign on with a user ID and password to authenticate the request. |
| 3 | *CERTIFICATE The request was authenticated through the use of certificates. |
Spooled file creation security method. The security method used when creating the spooled file.
Valid values are:
| 0 | *NONE No security method was used. |
| 1 | *SSL3 The SSL3 security method was used. |
Spooled file level. The level of the spooled file in Version, Release, and Modification level format (VxRxMx). The following is a list of the spooled file levels and the size in bytes required for the SPLFA0200 structure.
The length in bytes required for the different spooled file levels does not include the space required to specify any user-defined options, user resource libraries, edge-stitch staple offsets, or saddle-stitch staple offsets.
| 3320 | V2R3M0 |
| 3446 | V3R1M0, V3R2M0, and V3R6M0 |
| 3745 | V3R7M0, V4R1M0, and V4R1M4 |
| 3772 | V4R2M0 |
| 3784 | V4R3M0, V4R4M0, and V4R5M0 |
| 3816 | V5R1M0 |
| 3824 | V5R2M0 and V5R3M0 |
| 3841 | V5R4M0 and V6R1M0 |
Spooled file name. The name of the spooled file whose information is retrieved.
Spooled file number. The spooled file number of the specified file.
Spooled file size. The size of the spooled file. This number needs to be multiplied by the spooled file mulitiplier field to get the size of the spooled file in number of bytes. This size is the data stream size plus the "overhead" storage to store the spooled file's data stream.
Spooled file size multiplier. The value to multiply the spooled file size by to get the size of the spooled file in bytes.
Starting page. The page at which printing is to start for the spooled file.
Special values include:
| -1 | Use the ending page value. |
| 0 | Printing starts on page 1. |
Status. The status of the file is one of the following values:
| *CLOSED | The program completely processed the file, but SCHEDULE(*JOBEND) was specified, and the job that produced the file has not yet finished. |
| *DEFERRED | The spooled file has been deferred from printing. |
| *SENDING | The spooled file is being sent or has been sent to a remote system. |
| *HELD | The file is held. |
| *MESSAGE | The file has a message requiring a reply or an action. |
| *OPEN | The file was not completely processed and is not ready for a writer. |
| *PENDING | The file is pending to be printed. |
| *PRINTER | The complete file was sent to the printer, but a print complete status was not sent back. |
| *READY | The file is available to be written. |
| *SAVED | The file was written and is saved. This file remains saved until it is released. |
| *WRITING | The writer is writing the file on a diskette or a printer device. |
Subscript. Whether the spooled file contains subscript.
Valid values are Y (yes) or N (no). Set this field to N for all other printer device types.
Superscript.Whether the spooled file contains superscript.
Valid values are Y (yes) or N (no). Set this field to N for all other printer device types.
System where file originated. The name of the system where the spooled file data originated. If the creating system was a System i product running OS/400® version 2 or earlier, the address of the user that sent the file is displayed.
When the name of the system where this spooled file was created cannot be
determined, the receiving system name is used. For example, a file sent using
SNDNETSPLF DTAFMT(*RCDDATA).
System/36 procedure name. The name of the procedure running when the spooled file is created.
System/36 spooled file identifier. The 6-character identifier assigned to the spooled file.
System/38 text utility flags. The flag for advanced functions. This field is set to hexadecimal zeros when a spooled file is being created as opposed to copying an existing file.
S36 CONTINUE-YES. Whether the file is created as if the System/36 environment OCL statement "// PRINTER CONTINUE-YES" is in effect, as described under the QUSRSPLA API. The possible values are Y or N. See the corresponding field description under the QUSRSPLA API.
The value of this field in format SPLA0200 should be left undisturbed for most applications. For user-built attributes, a value of N (no) is generally recommended, unless the user has specific reasons for specifying Y (yes).
Time file opened (created). The time, in local job time, that the file was opened in the HHMMSS format where:
| HH | Hour |
| MM | Minutes |
| SS | Seconds |
Time writer began processing spooled file. The time, in local job time, that a spooling writer started processing the spooled file.
Time writer completed processing spooled file. The time, in local job time, that a spooling writer completed processing the spooled file.
Total copies. Total copies to be produced for this spooled file.
Total pages. The number of pages this printer file contains.
Total records. The number of data records. This field is only used when the device type (DEVTYPE) parameter of the printer file is *AFPDS, *LINE, or *AFPDSLINE.
Transparency. Whether the SCS Transparency command is used in the spooled file. It is set to N for all other device type files, such as IPDS.
For DEVTYPE(*SCS), a TRANSPARENT SCS command is contained in the spooled file.
Valid values are Y (yes) or N (no).
TRC for 1403. Whether the file contains 1403 line data with table-reference characters (TRC). This field is only used for device types (DEVTYPE) *LINE and *AFPDSLINE.
Valid values are Y (yes) or N (no). Set this field to N for all other printer device types.
Unit of measure. The unit of measure to use for specifying distances. The unit of measure is used with certain parameters of the printer file. Page definitions and form definitions are examples of these parameters.
The possible values are:
| *CM | Centimeters |
| *INCH | Inches |
Unrecognizable data. Whether the file contains SCS commands that are not valid because of one of the following:
Valid values are Y (yes) or N (no). Set this field to N for all other printer device types.
User name. The user name of the owner of the new spooled file being created. If the user name is the current user, the spooled file is created as part of the current job. If the user name is someone other than the current user, the spooled file is created as part of the special system job QPRTJOB for the user name specified. The current user must have *SPLCTL authority.
User object type. The type of the user-defined object. Possible values follow:
This field should be set to blanks when the user-defined object name is set to *NONE.
User-defined data. The data defined by the user to be used by user applications or user-specified programs that process spooled files. The special value of *NONE should be used when there is no user-defined data.
User-defined file. Whether the spooled file was created by using an API.
The possible values are:
| *YES | The spooled file was created using the QSPCRTSP API. |
| *NO | The spooled file was created by normal system functions. |
User-defined object library name. The library that contains the user-defined object. This field should be set to blanks when the user-defined object name field is set to *NONE.
User-defined object name. The name of the user-defined object that is used by user applications or user-specified programs that process spooled files. The special value of *NONE should be used when there is no user-defined object.
User-defined text. User-defined text taken from the interactive user profile when the spooled file was created.
The text is not converted because the text may not be presented to a user. It may be processed by a server type job and converted at a later date.
User-generated data stream. Whether the data stream has been validated by a system program on the System i platform when the data was spooled, for example, the OfficeVision program.
Valid values are Y (yes) or N (no). This field should be set to Y (data stream not validated) when opening a spooled file that contains data that has not been spooled, for example, OfficeVision spooled files.
User-specified data. The 10 characters of user-specified data that describe the file.
User who created file. The name of the user profile that created this file. If the spooled file was created on a System i platform running OS/400 version 2 or earlier, the user id that sent the file is displayed.
When the name of the user profile that created this file cannot be
determined, the name of the receiving user profile is used. For example, a file
sent using SNDNETSPLF DTAFMT(*RCDDATA).
Volumes (array). The diskette volumes used for saving the object. The variable returns a maximum of 10 six-character volumes. The volume IDs begin in character positions 1, 8, 15, 22, 29, 36, 43, 50, 57, and 64. If more than 10 volumes are used, a 1 is returned in the 71st character of the variable; otherwise, the 71st character is blank. The variable is returned blank if the object was saved to a save file, or if it was never saved.
Width of drawer 1. The width in inches of the paper in drawer 1. This field is set to packed 0 when the spooled file is being created as opposed to being copied. All other drawer fields should also be set to packed 0.
Width of drawer 2. The width in inches of the paper in drawer 2. This field is set to packed 0 when the spooled file is being created as opposed to being copied. All other drawer fields should also be set to packed
Width of page. The width of a page in rows and columns (*ROWCOL) or in inches and centimeters (*UOM). The width of a page is determined by the value specified on the PAGESIZE parameter of the printer file.
If this field is specified and the measurement method used is *ROWCOL, this value should be the same as that specified on the page width field found in this format.
If this field is specified and the measurement method is *UOM, this value must be equivalent to that specified on the page width field found in this format.
If the measurement method is *ROWCOL, the page width value must be from 1 through 378. If the measurement method is *UOM, the page width value must be between 0 and 57.79.
3812 SCS. Whether the spooled file contains fonts supported only on the 3812 printer.
For DEVTYPE(*SCS), a Set Coded Font Local command with a global ID of greater than 255 is contained in the spooled file.
Valid values are Y (yes) or N (no). Set this field to N for all other printer device types.
3812 SCS commands. Whether the file contains commands that are not valid on the 3812 printer.
Valid values are Y (yes) or N (no). Set this field to N for all other printer device types.
5A present. Whether the hex 5A constant is present in all AFPDS data for the file (in format SPLF0200). This field is valid when the printer device type (DEVTYPE) field is *AFPDS.
Valid values are Y (yes) or N (no). This field should be set to N for all other printer device types.
5219 commands. Whether the file contains commands that are not valid on a 5219 printer. The data stream contains one or more of the following SCS commands which, either are not valid on a 5219 or contain parameters that are not valid.
Valid values are Y (yes) or N (no).
| Message ID | Error Message Text |
|---|---|
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF3C19 E | Error occurred with receiver variable specified. |
| CPF3C21 E | Format name &1 is not valid. |
| CPF3C90 E | Literal value cannot be changed. |
| CPF33DD E | Maximum number of open spooled files exceeded for this job. |
| CPF33DE E | Size of internal data for opened spooled file exceeds maximum. |
| CPF33DF E | Internal data area for opened spooled files destroyed. |
| CPF33E0 E | Incomplete set of attributes provided. |
| CPF33E1 E | Attributes are for an opened spooled file. |
| CPF33E2 E | Value &1 for spooled file attribute at offset &2 not valid. |
| CPF34B1 E | Spooled file print data format not supported. |
| CPF34B2 E | Spooled file input record length is not valid. |
| CPF9801 E | Object &2 in library &3 not found. |
| CPF9838 E | User profile storage limit exceeded. |
| CPF9845 E | Error occurred while opening file &1. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
[ Back to top | Print APIs | APIs by category ]