Change Printer File (CHGPRTF)

Where allowed to run: All environments (*ALL)
Threadsafe: No
Parameters
Examples
Error messages

The Change Printer File (CHGPRTF) command changes the attributes of the specified printer device file.

Only the information specified on this command can be changed. If the data description specifications (DDS) used to create the file are changed, the printer device file must be created again before the changes can be made in the file.

Top

Parameters

Keyword Description Choices Notes
FILE File Qualified object name Required, Key, Positional 1
Qualifier 1: File Generic name, name, *ALL
Qualifier 2: Library Name, *LIBL, *ALL, *ALLUSR, *CURLIB, *USRLIBL
DEV Device Element list Optional, Positional 2
Element 1: Printer Name, *SAME, *JOB, *SYSVAL
DEVTYPE Printer device type *SAME, *SCS, *IPDS, *LINE, *AFPDSLINE, *USERASCII, *AFPDS Optional
PAGESIZE Page size Element list Optional
Element 1: Length--lines per page 0.001-255.0, *SAME
Element 2: Width--positions per line 0.001-378.0, *SAME
Element 3: Measurement method *SAME, *ROWCOL, *UOM
LPI Lines per inch *SAME, 6.0, 3.0, 4.0, 7.5, 7.5, 8.0, 9.0, 12.0 Optional
CPI Characters per inch *SAME, 10.0, 5.0, 12.0, 13.3, 13.3, 15.0, 16.7, 16.7, 18.0, 20.0 Optional
OVRFLW Overflow line number 1-255, *SAME Optional
LVLCHK Record format level check *SAME, *YES, *NO Optional
TEXT Text 'description' Character value, *SAME, *BLANK Optional
FRONTMGN Front margin Single values: *SAME, *DEVD
Other values: Element list
Optional
Element 1: Offset down 0.0-57.79
Element 2: Offset across 0.0-57.79
BACKMGN Back margin Single values: *FRONTMGN, *DEVD, *SAME
Other values: Element list
Optional
Element 1: Offset down 0.0-57.79
Element 2: Offset across 0.0-57.79
FOLD Fold records *SAME, *NO, *YES Optional
RPLUNPRT Unprintable character action Single values: *NO
Other values: Element list
Optional
Element 1: Replace character *SAME, *YES
Element 2: Replacement character X'40'-X'FE', *SAME, *BLANK
ALIGN Align page *SAME, *NO, *YES Optional
CTLCHAR Control character *SAME, *NONE, *FCFC, *MACHINE Optional
CHLVAL Channel values Single values: *SAME, *NORMAL
Other values (up to 12 repetitions): Element list
Optional
Element 1: Channel 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12
Element 2: Line number for channel Element list
Element 1: Line 1-255
FIDELITY Fidelity *SAME, *CONTENT, *ABSOLUTE Optional
PRTQLTY Print quality *SAME, *STD, *DEVD, *DRAFT, *NLQ, *FASTDRAFT Optional
FORMFEED Form feed *SAME, *DEVD, *AUTOCUT, *CONT, *CUT, *CONT2 Optional
DRAWER Source drawer 1-255, *SAME, *E1, *FORMDF Optional
OUTBIN Output bin 1-65535, *SAME, *DEVD Optional
FONT Font Single values: *SAME, *CPI, *DEVD
Other values: Element list
Optional
Element 1: Identifier Character value, 2, 002, 3, 003, 5, 005, 8, 008, 10, 010, 11, 011, 12, 012, 13, 013, 18, 018, 19, 019, 20, 020, 21, 021, 25, 025, 26, 026, 30, 030, 31, 031, 36, 036, 38, 038, 39, 039, 40, 040, 41, 041, 42, 042, 43, 043, 44, 044, 46, 046, 49, 049, 50, 050, 51, 051, 52, 052, 55, 055, 61, 061, 62, 062, 63, 063, 64, 064, 66, 066, 68, 068, 69, 069, 70, 070, 71, 071, 72, 072, 74, 074, 75, 075, 76, 076, 78, 078, 80, 080, 84, 084, 85, 085, 86, 086, 87, 087, 91, 091, 92, 092, 95, 095, 96, 096, 98, 098, 99, 099, 101, 102, 103, 109, 110, 111, 112, 154, 155, 157, 158, 159, 160, 162, 163, 164, 167, 168, 173, 174, 175, 178, 179, 180, 181, 182, 183, 186, 187, 188, 189, 190, 191, 194, 195, 204, 205, 211, 212, 221, 222, 223, 225, 226, 229, 230, 232, 233, 234, 244, 245, 247, 248, 249, 252, 253, 254, 255, 256, 258, 259, 279, 281, 282, 285, 290, 300, 304, 305, 306, 307, 318, 319, 400, 404, 416, 420, 424, 428, 432, 434, 435, 751, 752, 753, 754, 755, 756, 757, 758, 759, 760, 761, 762, 763, 764, 765, 1051, 1053, 1056, 1351, 1653, 1803, 2103, 2304, 2305, 2306, 2307, 2308, 2309, 2310, 2311, 4407, 4427, 4535, 4919, 4939, 5047, 5067, 5687, 5707, 5815, 5835, 5943, 6199, 6219, 6327, 6347, 8503, 8523, 8631, 8651, 8759, 8779, 8887, 8907, 12855, 12875, 16951, 16971, 17079, 17099, 33335, 33355, 33463, 33483, 33591, 33601, 33719, 33729, 34103, 34123, 34231, 34251, 37431, 41783, 41803
Element 2: Point size 0.1-999.9, *NONE
CHRID Character identifier Single values: *SAME, *DEVD, *SYSVAL, *JOBCCSID, *CHRIDCTL
Other values: Element list
Optional
Element 1: Graphic character set Integer
Element 2: Code page Integer
DECFMT Decimal format *SAME, *FILE, *JOB Optional
FNTCHRSET Font character set Single values: *SAME, *FONT
Other values: Element list
Optional
Element 1: Character set Qualified object name
Qualifier 1: Character set Name
Qualifier 2: Library Name, *LIBL, *CURLIB
Element 2: Code page Qualified object name
Qualifier 1: Code page Name
Qualifier 2: Library Name, *LIBL, *CURLIB
Element 3: Point size 0.1-999.9, *NONE
CDEFNT Coded font Single values: *SAME, *FNTCHRSET
Other values: Element list
Optional
Element 1: Coded font Qualified object name
Qualifier 1: Coded font Name
Qualifier 2: Library Name, *LIBL, *CURLIB
Element 2: Point size 0.1-999.9, *NONE
TBLREFCHR Table Reference Characters *SAME, *YES, *NO Optional
PAGDFN Page definition Single values: *SAME, *NONE
Other values: Qualified object name
Optional
Qualifier 1: Page definition Name
Qualifier 2: Library Name, *LIBL, *CURLIB
FORMDF Form definition Single values: *SAME, *NONE, *DEVD
Other values: Qualified object name
Optional
Qualifier 1: Form definition Name
Qualifier 2: Library Name, *LIBL, *CURLIB
AFPCHARS AFP Characters Single values: *SAME, *NONE
Other values (up to 4 repetitions): Character value
Optional
PAGRTT Degree of page rotation *SAME, *AUTO, *DEVD, *COR, 0, 90, 180, 270 Optional
MULTIUP Pages per side 1-4, *SAME Optional
REDUCE Reduce output *SAME, *TEXT, *NONE Optional
PRTTXT Print text Character value, *SAME, *JOB, *BLANK, X'' Optional
JUSTIFY Hardware justification *SAME, 0, 50, 100 Optional
DUPLEX Print on both sides *SAME, *NO, *YES, *TUMBLE, *FORMDF Optional
DFRWRT Defer write *SAME, *YES, *NO Optional
UOM Unit of measure *SAME, *INCH, *CM Optional
FRONTOVL Front side overlay Single values: *NONE
Other values: Element list
Optional
Element 1: Overlay Single values: *SAME
Other values: Qualified object name
Qualifier 1: Overlay Name
Qualifier 2: Library Name, *LIBL, *CURLIB
Element 2: Offset down 0.0-57.79, *SAME
Element 3: Offset across 0.0-57.79, *SAME
BACKOVL Back side overlay Single values: *FRONTOVL, *NONE
Other values: Element list
Optional
Element 1: Overlay Single values: *SAME
Other values: Qualified object name
Qualifier 1: Overlay Name
Qualifier 2: Library Name, *LIBL, *CURLIB
Element 2: Offset down 0.0-57.79, *SAME
Element 3: Offset across 0.0-57.79, *SAME
Element 4: Constant back *NOCONSTANT, *CONSTANT, *SAME
CVTLINDTA Convert line data *NO, *YES, *SAME Optional
IPDSPASTHR IPDS pass through *DEVD, *NO, *YES, *SAME Optional
USRRSCLIBL User resource library list Single values: *DEVD, *NONE, *JOBLIBL, *CURLIB, *SAME
Other values (up to 4 repetitions): Name
Optional
CORNERSTPL Corner staple *NONE, *BOTRIGHT, *TOPRIGHT, *TOPLEFT, *BOTLEFT, *DEVD, *SAME Optional
EDGESTITCH Edge stitch Single values: *NONE
Other values: Element list
Optional
Element 1: Reference edge *DEVD, *BOT, *RIGHT, *TOP, *LEFT, *SAME
Element 2: Reference edge offset 0.0-57.79, *DEVD, *SAME
Element 3: Number of staples 1-122, *DEVD, *SAME
Element 4: Staple offsets Single values: *DEVD, *SAME
Other values (up to 122 repetitions): 0.0-57.79
SADLSTITCH Saddle stitch Single values: *NONE
Other values: Element list
Optional
Element 1: Reference edge *TOP, *LEFT, *DEVD, *SAME
Element 2: Number of staples 1-122, *DEVD, *SAME
Element 3: Staple offsets Single values: *DEVD, *SAME
Other values (up to 122 repetitions): 0.0-57.79
FNTRSL Font resolution for formatting *DEVD, *SEARCH, 240, 300, *SAME Optional
SPOOL Spool the data *SAME, *YES, *NO Optional
OUTQ Spooled output queue Single values: *SAME, *JOB, *DEV
Other values: Qualified object name
Optional
Qualifier 1: Spooled output queue Name
Qualifier 2: Library Name, *LIBL, *CURLIB
FORMTYPE Form type Character value, *SAME, *STD Optional
COPIES Copies 1-255, *SAME Optional
EXPDATE Expiration date for file Date, *DAYS, *NONE, *SAME Optional
DAYS Days until file expires 1-366 Optional
PAGERANGE Page range to print Element list Optional
Element 1: Starting page Integer, 1, *SAME, *ENDPAGE
Element 2: Ending page Integer, *SAME, *END
MAXRCDS Max spooled output records 1-99999999, *SAME, *NOMAX Optional
FILESEP File separators 0-9, *SAME Optional
SCHEDULE Spooled output schedule *SAME, *FILEEND, *JOBEND, *IMMED Optional
HOLD Hold spooled file *SAME, *NO, *YES Optional
SAVE Save spooled file *SAME, *NO, *YES Optional
OUTPTY Output priority (on OUTQ) *SAME, *JOB, 1, 2, 3, 4, 5, 6, 7, 8, 9 Optional
USRDTA User data Character value, *SAME, *SOURCE Optional
SPLFOWN Spool file owner *SAME, *CURUSRPRF, *JOB, *CURGRPPRF, *JOBGRPPRF Optional
USRDFNOPT User Defined Option Single values: *SAME, *NONE
Other values (up to 4 repetitions): Character value
Optional
USRDFNDTA User Defined Data Character value, *SAME, *NONE Optional
USRDFNOBJ User Defined Object Single values: *SAME, *NONE
Other values: Element list
Optional
Element 1: Object Qualified object name
Qualifier 1: Object Name
Qualifier 2: Library Name, *LIBL, *CURLIB
Element 2: Object type *SAME, *DTAARA, *DTAQ, *FILE, *PSFCFG, *USRIDX, *USRQ, *USRSPC
IGCDTA User specified DBCS data *SAME, *NO, *YES Optional
IGCEXNCHR DBCS extension characters *SAME, *YES, *NO Optional
IGCCHRRTT DBCS character rotation *SAME, *NO, *YES Optional
IGCCPI DBCS characters per inch *SAME, *CPI, *CONDENSED, 5, 6, 10 Optional
IGCSOSI DBCS SO/SI spacing *SAME, *YES, *NO, *RIGHT Optional
IGCCDEFNT DBCS coded font Single values: *SAME, *SYSVAL
Other values: Element list
Optional
Element 1: DBCS coded font Qualified object name
Qualifier 1: DBCS coded font Name
Qualifier 2: Library Name, *LIBL, *CURLIB
Element 2: Point size 0.1-999.9, *NONE
TOSTMF To stream file Path name, *SAME, *NONE Optional
WSCST Workstation customizing object Single values: *SAME, *NONE, *PDF
Other values: Qualified object name
Optional
Qualifier 1: Workstation customizing object Name
Qualifier 2: Library Name, *LIBL, *CURLIB
WAITFILE Maximum file wait time Integer, *SAME, *IMMED, *CLS Optional
SHARE Share open data path *SAME, *NO, *YES Optional
Top

File (FILE)

Specifies the printer device file whose description is to be changed. A generic printer device file name may be specified.

This is a required parameter.

Qualifier 1: File

*ALL
All printer device files in the specified library are changed.
name
Specify the name of the printer device file.
generic-name
Specify the generic file name of the printer device whose description is being changed. A generic name is a character string that contains one or more characters followed by an asterisk (*).
*LIBL
All libraries in the library list for the current thread are searched until the first match is found.
*CURLIB
Only the libraries in the current library for the job are searched. If no library is specified as the current library for the job, QGPL is used.
*USRLIBL
If a current library entry exists in the library list for the current thread, the current library and the libraries in the user portion of the library list are searched. If there is no current library entry, only the libraries in the user portion of the library list are searched.
*ALL
All libraries in the system, including QSYS, are searched.
*ALLUSR
All user libraries are searched. All libraries with names that do not begin with the letter Q are searched except for the following:

#CGULIB     #DSULIB     #SEULIB
#COBLIB     #RPGLIB
#DFULIB     #SDALIB

Although the following Qxxx libraries are provided by IBM, they typically contain user data that changes frequently. Therefore, these libraries are considered user libraries and are also searched:

QDSNX       QRCLxxxxx   QUSRDIRDB   QUSRVI
QGPL        QSRVAGT     QUSRIJS     QUSRVxRxMx
QGPL38      QSYS2       QUSRINFSKR
QMGTC       QSYS2xxxxx  QUSRNOTES
QMGTC2      QS36F       QUSROND
QMPGDATA    QUSER38     QUSRPOSGS
QMQMDATA    QUSRADSM    QUSRPOSSA
QMQMPROC    QUSRBRM     QUSRPYMSVR
QPFRDATA    QUSRDIRCF   QUSRRDARS
QRCL        QUSRDIRCL   QUSRSYS

  1. 'xxxxx' is the number of a primary auxiliary storage pool (ASP).
  2. A different library name, in the format QUSRVxRxMx, can be created by the user for each previous release supported by IBM to contain any user commands to be compiled in a CL program for the previous release. For the QUSRVxRxMx user library, VxRxMx is the version, release, and modification level of a previous release that IBM continues to support.
name
Specify a library name. Only the library named in this parameter is searched.
Top

Device (DEV)

Specifies the name of a printer device description. For nonspooled output, this identifies the printer device used to produce the printed output. For spooled output, the file is placed on the output queue determined by the OUTQ parameter. If OUTQ(*DEV) is used, the file is placed on the output queue with the same name as the device.

*SAME
The device name (if any) does not change.
*JOB
The printer associated with the job is the printer device.
*SYSVAL
The printer device named in the system value QPRTDEV is used.
name
Specify the name of the printer device used with this printer file.

Double-byte character set considerations

When printing a printer file that has double-byte character set (DBCS) data, specify a DBCS printer.

Top

Printer device type (DEVTYPE)

Specifies the type of data stream that is used for a printer device file.

*SAME
The data stream type does not change.
*SCS
An SNA character stream (SCS) is created. This parameter must be specified when using the 3287, 3812 SCS, 3816 SCS, 4214, 4234 SCS, 4245, 5219, 5224, 5225, 5256, 5262, 6252, or 6262 work station printers.
  • If *SCS is specified and the spooled printer file is directed to an IPDS printer, the SCS printer file is converted to emulate an IPDS printer file. More information is in the Printing category in the IBM i Information Center at http://www.ibm.com/systems/i/infocenter/.

Double-byte character set considerations

When using the 5553 and 5583 DBCS-capable printers, DEVTYPE(*SCS) must be specified.

*IPDS
An intelligent printer data stream (IPDS) is created. This parameter can be specified when using an IPDS printer.
  • If *IPDS is specified and the spooled printer file is directed to a printer other than an IPDS printer, the IPDS printer file is converted to an SCS printer file. More information is in the Printing category in the IBM i Information Center at http://www.ibm.com/systems/i/infocenter/.
*USERASCII
An ASCII data stream is placed on a spooled output queue. You are responsible for placing the entire hexadecimal data stream in the buffer, since the System i5 does not change or validate the values that are passed. This parameter cannot be specified with SPOOL(*NO).
*AFPDS
An Advanced Function Printing data stream (AFPDS) is created. Some systems refer to this data stream as MODCA-P.
*AFPDSLINE
Mixed data (line data and AFPDS data) is created. This value can be specified when using any printer supported by PSF. The printer must be configured with AFP(*YES).
*LINE
Line data is created. This value can be specified when using any printer supported by PSF. The printer must be configured with AFP(*YES).
Top

Page size (PAGESIZE)

Specifies the length and width of the printer forms used by this device file. The length is specified in lines per page or by the units specified for the UOM parameter. The width is specified in print positions (characters) per line or by the units specified for the Unit of measure (UOM) parameter.

The page size must be specified with reference to the way the data is printed on the page. For example, if using 8.5 inch wide by 11.0 inch long forms and printing at 6 lines per inch with a 10-pitch font, specify PAGESIZE(66 85) PAGRTT(0). However, to rotate the page, specify the page size for an 11.0 inch wide by 8.5 inch long page and enter PAGESIZE(51 110) PAGRTT(90).

Note: Specify PAGRTT(*AUTO) or PAGRTT(*DEVD) and PRTQLTY(*DRAFT) on this command to enable automatic reduction or rotation if the data does not fit on the paper.

Specify PAGRTT(*COR) on this command to enable automatic reduction whether or not the data fits on the paper.

Element 1: Length--lines per page

*SAME
The page length value does not change.
0.001-255.0
Specify the page length that is used by this printer file. The value specified must not exceed the actual length of the forms used.

Element 2: Width--positions per line

*SAME
The page width value does not change.
0.001-378.0
Specify the page width that is used by this printer file. The value specified must not exceed the actual width of the forms used.

Element 3: Measurement method

*SAME
This value does not change.
*ROWCOL
Page length and page width are measured as numbers of rows and columns.
*UOM
Page length and page width are measured in the units specified for the UOM parameter.
Top

Lines per inch (LPI)

Specifies the line spacing setting on the printer (in lines per inch) used by this device file. The line spacing on the 5256 printer must be set manually. When the lines per inch (LPI) value on this parameter changes (from the value on the previous printer file), an inquiry message is sent to the message queue associated with the printer that requests a change to the LPI value.

The line spacing on the 4214, 4224, and 4234 printers is set by a print command. These also allow setting the lines per inch spacing on the control panel of the printer. The lines per inch value must not be set at the printer. If the LPI value is overridden at the control panel, the system overrides the value set with the LPI value of the next printer file received.

*SAME
The printer line spacing value does not change.
6
The line spacing on the printer is 6 lines per inch. This is the default value for this parameter on the CRTPRTF command.
3
The line spacing on the printer is 3 lines per inch. This value is valid only for double-byte character set (DBCS) printers.
4
The line spacing on the printer is 4 lines per inch.
7.5
The line spacing on the printer is 7.5 lines per inch. This value is valid only for double-byte character set (DBCS) printers.
8
The line spacing on the printer is 8 lines per inch.

Note: When printing double-byte character set (DBCS) data for a file specified with LPI(8), use double spacing. Otherwise, the DBCS data does not print correctly. Alphanumeric data, however, prints correctly in single spacing when LPI(8) is specified.

9
The line spacing on the printer is 9 lines per inch.
12
The line spacing on the printer is 12 lines per inch.

Double-byte character set considerations

Top

Characters per inch (CPI)

Specifies the printer character density (in characters per inch) used by this device file.

For the printers that support fonts, the value specified in the font special value implies the CPI. If FONT(*CPI) is specified, the font used is based on the CPI value. The following diagram describes the default font ID for each CPI value:

 CPI         FONT ID DEFAULT
 5           245
 10          011
 12          087
 13.3        204
 15          222
 16.7        400
 18          252
 20          281

*SAME
The character density does not change.
10
Character density is 10 characters per inch. This is the shipped default value for this parameter on the CRTPRTF command.
5
Character density is 5 characters per inch. This density is valid only for the 4214 printer.
12
Character density is 12 characters per inch. This density is valid only for the 4214 printer.
13.3
Character density is 13.3 characters per inch. This value is valid only for double-byte character set (DBCS) printers.
15
Character density is 15 characters per inch.
16.7
Character density is 16.7 characters per inch.
18
Character density is 18 characters per inch. This value is valid only for double-byte character set (DBCS) printers.
20
Character density is 20 characters per inch. This value is valid only for double-byte character set (DBCS) printers.
Top

Overflow line number (OVRFLW)

Specifies the line number on the page at which overflow to a new page begins. Generally, after the specified line is printed, the printer overflows to the next page before printing continues. Margins specified for the printer file are ignored when determining overflow. More information is in the Printing category in the IBM i Information Center at http://www.ibm.com/systems/i/infocenter/.

*SAME
The overflow line number does not change.
1-255
Specify the line number of the line that signals page overflow after the line is printed. The value specified must not exceed the page length specified for the file. Margins specified for the printer file are ignored when determining overflow.
Top

Record format level check (LVLCHK)

Specifies whether the level identifiers of the record formats in this device file are checked when the file is opened by a program.

*SAME
This value does not change.
*YES
The level identifiers are checked. If they do not all match, an open exception occurs, and an error message is sent to the program requesting the open.
*NO
The level identifiers are not checked when the file is opened.
Top

Text 'description' (TEXT)

Specifies text that describes the printer device file.

*SAME
The text (if any) does not change.
*BLANK
No text is specified.
character-value
Specify no more than 50 characters of text, enclosed in apostrophes.
Top

Front margin (FRONTMGN)

Specifies the offset, down and across, of the origin from the edge on the front side of the paper. The offsets are in the units of measure specified on the UOM parameter. This parameter can only be used for printer files with DEVTYPE(*AFPDS) specified.

Single values

*SAME
This value does not change.
*DEVD
The no-print border from the printer is used to place the text on the page when printing to a printer configured with AFP(*YES). A margin of 0 is used for IPDS printers without a no-print border, or which are configured with AFP(*NO).

Element 1: Offset down

0.0-57.79
Specify the offset of the origin from the top of the page. If *CM (centimeter) is specified for the Unit of measure (UOM) parameter, valid values range from 0 through 57.79. If *INCH is specified for the UOM parameter, valid values range from 0 through 22.75.

Element 2: Offset across

0.0-57.79
Specify the offset of the origin from the left side of the page. If *CM (centimeter) is specified for the Unit of measure (UOM) parameter, valid values range from 0 through 57.79. If *INCH is specified for the UOM parameter, valid values range from 0 through 22.75.
Top

Back margin (BACKMGN)

Specifies the offset, down and across, of the origin from the edge on the back side of the paper. The offsets are in the units of measure specified on the UOM parameter. This parameter can only be used for printer files with DEVTYPE(*AFPDS) specified.

Single values

SAME
This value does not change.
*FRONTMGN
The offsets specified for the Front margin (FRONTMGN) parameter are used.
*DEVD
The no-print border from the printer is used to place the text on the page when printing to a printer configured with AFP(*YES). A margin of 0 is used for IPDS printers without a no-print border, or which are configured with AFP(*NO).

Element 1: Offset down

0.0-57.79
Specify the offset of the origin from the top of the page. If *CM (centimeter) is specified for the Unit of measure (UOM) parameter, valid values range from 0 through 57.79. If *INCH is specified for the UOM parameter, valid values range from 0 through 22.75.

Element 2: Offset across

0.0-57.79
Specify the offset of the origin from the left side of the page. If *CM (centimeter) is specified for the Unit of measure (UOM) parameter, valid values range from 0 through 57.79. If *INCH is specified for the UOM parameter, valid values range from 0 through 22.75.
Top

Fold records (FOLD)

Specifies whether all positions in a record are printed when the record length exceeds the page width (specified by the PAGESIZE parameter). When folding is specified and a record exceeds the page width, any portion of the record that cannot be printed on the first line continues (is folded) on the next line or lines until the entire record has been printed.

The FOLD parameter is ignored under the following conditions:

Double-Byte Character Set Considerations

The system ignores this parameter when printing double-byte character set (DBCS) files. The system assumes that DBCS records fit on a printed line. If the record exceeds the page width, the system continues printing the record on the next line.

*SAME
The value does not change.
*YES
Records whose length exceeds the page width are folded on the following lines.
*NO
Records are not folded. If a record is longer than the page width, only the first part of the record that fits on one line is printed.
Top

Unprintable character action (RPLUNPRT)

Specifies whether unprintable characters are replaced and which substitution character (if any) is used.

Note: If DEVTYPE(*IPDS) and RPLUNPRT(*YES) are specified, a hyphen (-) is printed for the unprintable character.

Double-Byte Character Set Considerations

For double-byte character set (DBCS) data, an unprintable character is one that cannot be processed. When using DBCS-capable printers, consider the following:

More information is in the Printing category in the IBM i Information Center at http://www.ibm.com/systems/i/infocenter/.

Single values

*NO
Unprintable characters are not replaced. When an unprintable character is detected, a message is sent to the program.

Element 1: Replace character

*SAME
This value does not change.
*YES
Unprintable characters are replaced. The program is not notified when unprintable characters are detected.

Element 2: Replacement character

*SAME
This value does not change.
*BLANK
A blank (X'40') is used as the substitution character when an unprintable character is detected.
X'40'-X'FE'
Specify the replacement character that is used each time an unprintable character is detected. This character is used only if *YES is also specified in this parameter. Any printable EBCDIC character can be specified.
Top

Align page (ALIGN)

Specifies whether the pages must be aligned in the printer before printing is started. If ALIGN(*YES) and SPOOL(*NO) are specified, and forms alignment is required, the system sends a message to the message queue specified in the printer device description and waits for a reply to the message. When SPOOL(*YES) is specified on the Create Printer File (CRTPRTF) command and ALIGN(*FILE) is specified on the Start Print Writer (STRPRTWTR) command, this parameter is used to determine whether an alignment message is sent by the system.

This parameter is ignored when cut sheets are used (spooled and direct output). Page alignment can be done only for text-only files. Page alignment cannot be done for print jobs containing graphics or bar codes.

*SAME
This value does not change.
*NO
No alignment of pages is required.
*YES
The pages are aligned before the output is printed.
Top

Control character (CTLCHAR)

Specifies whether the printer device file supports input with print control characters. Control characters that are not valid are ignored. Single spacing is assumed.

*SAME
This value does not change.
*NONE
No print control characters are passed in the data that is printed.
*FCFC
The first character of every record is an American National Standards Institute (ANSI) forms control character. If *FCFC is specified, the record length must include one position for the first-character forms-control code. This value is not valid for externally described printer files.
*MACHINE
The first character of every record contains a machine code control character. If *MACHINE is specified, the record length must include one extra position for the first character forms control code. This value is not valid for externally described printer files.

If TBLREFCHR(*YES) is also specified, then the record length must include two extra positions for the control character and the table reference character.

Top

Channel values (CHLVAL)

Specifies a list of up to 12 channel numbers with their assigned line numbers.

Note: If one or more channel-number plus line-number combinations are changed, all other combinations must be reentered.

Single values

*SAME
This value does not change.
*NORMAL
The default values for skipping to channel identifiers are used. The default values are found in the following table:

Code        Action before Printing a Line
-----       -----------------------------------------
' '         Space one line (blank code)
0           Space two lines
-           Space three lines
+           Suppress space
1           Skip to line 1
2-11        Space one line
12          Skip to overflow line (OVRFLW parameter)

Element 1: Channel

1-12
Specify an American National Standard channel number to be associated with a corresponding 'skip to' line number. Valid values for this parameter range from 1 through 12, corresponding to channels 1 through 12. The CHLVAL parameter associates the channel number with a page line number. For example, if you specify CHLVAL(2 20), channel identifier 2 is allocated with line number 20; therefore, if you place the forms-control 2 in the first position of a record, the printer skips to line 20 before printing the line.

Note: If the printer stops and the next record processed has a channel value forms-control number that is the same value as the line number the printer is on, the printer advances to that value (line number) on the next page. However, if the printer is positioned at the top of the page (line number one) and the channel value forms-control value is associated with line number one, the printer does not advance to a new page.

If no line number is specified for a channel identifier, and that channel identifier is encountered in the data, a default of 'space one line' before printing is used. Each channel number can be specified only once.

Element 2: Line number for channel

1-255
Specify the line number assigned for the channel number in the same list. Valid line numbers range from 1 through 255. If no line number is assigned to a channel number, and that channel number is encountered in the data, a default of 'space one line' before printing is used.
Top

Fidelity (FIDELITY)

Specifies whether printing continues when print errors are found for printers configured with AFP(*YES).

*SAME
The value does not change.
*CONTENT
Printing continues when errors are found.
*ABSOLUTE
Printing stops when errors are found.
Top

Print quality (PRTQLTY)

Specifies the quality of the print produced.

Note: See the description for this parameter on the Create Printer File (CRTPRTF) command for more details.

*SAME
This value does not change.
*STD
The output is printed with standard quality.
*DEVD
The print quality is set on the printer by the user. It is not set in the data stream.
*DRAFT
The output is printed with draft quality.
*NLQ
The output is printed with near letter quality.
*FASTDRAFT
The output is printed at a higher speed and with lower quality than it would be if you specified *DRAFT. This value is only supported by the 4230 printer.

Note: For the 4214 printer, only draft (*DRAFT), quality (*NLQ), and device default (*DEVD) modes are supported. Other values are set to quality (*NLQ) mode.

Top

Form feed (FORMFEED)

Specifies the form feed attachment used by this printer device file.

*SAME
This value does not change.
*DEVD
The forms are fed into the printer in the manner specified in the device description.
*CONT
Continuous forms are used by the printer. The tractor feed attachment must be mounted on the device.
*CONT2
Continuous forms are used by the printer. The form is fed from the secondary tractor feed attachment. The secondary tractor feed attachment must be on the printer device.
*CUT
Single-cut sheets are used by the printer. Each sheet must be manually loaded.
*AUTOCUT
Single-cut sheets are semiautomatically fed into the printer. The sheet-feed attachment must be mounted on the device.
Top

Source drawer (DRAWER)

Specifies the source drawer used when single-cut sheets are semiautomatically fed into the printer.

*SAME
The value does not change.
*E1
The envelopes are fed from the envelope drawer on the sheet-feed paper handler.
*FORMDF
The paper is fed from the source drawer specified in the form definition. If a form definition is not specified, then source drawer 1 is used.
1-255
Specify the drawer from which the paper is fed.
Top

Output bin (OUTBIN)

Specifies the destination of the output on printers capable of multiple output bins.

*SAME
The value does not change.
*DEVD
The destination of the output is the device default output bin.
1-65535
Specify the output bin for the destination of the output.
Top

Font identifier (FONT)

Specifies the font identifier and point size used with this printer device file.

Single values

*SAME
The font identifier does not change.
*CPI
The identifier of the font with the specified pitch (characters per inch (CPI)) is used.
*DEVD
The font identifier and point size specified in the device description are used.

Element 1: Identifier

identifier
Specify the numeric font identifier to be used with this printer device file.

Element 2: Point size

*NONE
No point size is specified; the system selects one based on the type of printer used.
0.1-999.9
Specify a point size.
Top

Character identifier (CHRID)

Specifies the character identifier (graphic character set and code page) for the file. This parameter allows printing of text that is in different character identifier (graphic character set and code page) coding. The value specified on this parameter is used to instruct the printer device to interpret the hexadecimal byte string to print the same characters that were intended when the text was created. More information about the character identifier is in the Printing category in the IBM i Information Center at http://www.ibm.com/systems/i/infocenter/. A list of valid CHRID values and applicable printers is in the "CHRID Values and Applicable Printers (CHRID parameter)" table in the Printing category in the IBM i Information Center at http://www.ibm.com/systems/i/infocenter/.

Single values

*SAME
This value does not change.
*DEVD
The character identifier value specified in the device description of the printer is used.
*SYSVAL
The character identifier value specified for the system on which the application is running is used.
*JOBCCSID
The character identifier for the printer file is taken from the coded character set identifier (CCSID) of the job.

Note: The *JOBCCSID special value, either specified directly on the CHRID command parameter or on the CHRIDCTL job attribute when the *CHRIDCTL special value is specified on the CHRID command parameter, is not allowed if the file was created on a system at an earlier release level than V2R3M0. A file created prior to V2R3M0 will not be tagged with a CCSID and can not be used in combination with the *JOBCCSID support.

*CHRIDCTL
The system checks the CHRIDCTL job definition attribute to determine whether to use *JOBCCSID or *DEVD on the CHRID command parameter for this file.

Element 1: Graphic character set

integer
Specify the graphic character set value that matches the printer.

Element 2: Code page

integer
Specify the code page value that matches the printer. Valid values range from 1 through 32767.
Top

Decimal format (DECFMT)

Specifies which decimal format value is used when editing numeric fields with the EDTCDE (Edit Code) DDS keyword. The decimal format value determines the use of commas and periods for the decimal position and three digit positional separators on edited fields.

*SAME
The job is submitted in the held (HLD) state.
*FILE
Use the decimal format value stored with the file when the file was created.
*JOB
Use the decimal format value from the DECFMT job attribute when the file is opened.
Top

Font character set (FNTCHRSET)

Specifies a downloaded font consisting of a character set and code page. This parameter can only be used for printer files with DEVTYPE(*AFPDS) specified.

Single values

*SAME
The value does not change.
*FONT
The value specified for the Font identifier (FONT) parameter is used.

Element 1: Character set

Qualifier 1: Character set

name
Specify the name of the font character set.

Qualifier 2: Library

*LIBL
All libraries in the library list for the current thread are searched until the first match is found.
*CURLIB
The current library for the job is used to locate the font character set. If no library is specified as the current library for the job, the QGPL library is used.
name
Specify the name of the library where the font character set is located.

Element 2: Code page

Qualifier 1: Code page

name
Specify the name of the code page.

Qualifier 2: Library

*LIBL
All libraries in the library list for the current thread are searched until the first match is found.
*CURLIB
The current library for the job is used to locate the code page name. If no library is specified as the current library for the job, the QGPL library is used.
name
Specify the name of the library where the code page object is located.

Element 3: Point size

*NONE
The point size is supplied by the system and is determined by the specified font character set.
0.1-999.9
Specify the point size to be used.
Top

Coded font (CDEFNT)

Specifies the coded font that the system uses for single-byte character set (SBCS) printing. This parameter can only be used for printer files with DEVTYPE(*AFPDS) specified.

Single values

*SAME
The value does not change.
*FNTCHRSET
The font specified for the Font character set (FNTCHRSET) parameter is used.

Element 1: Coded font

Qualifier 1: Coded font

name
Specify the name of the coded font.

Qualifier 2: Library

*LIBL
All libraries in the library list for the current thread are searched until the first match is found.
*CURLIB
The current library for the job is used to locate the coded font object. If no library is specified as the current library for the job, the QGPL library is used.
name
Specify the name of the library where the coded font object is located.

Element 2: Point size

*NONE
The point size is supplied by the system and is determined by the specified font character set.
0.1-999.9
Specify the point size to be used.
Top

Table Reference Characters (TBLREFCHR)

Specifies whether table reference characters are present in the line data.

*SAME
The value does not change.
*NO
No table reference character is present in line data.
*YES
Table reference characters are present in line data.

If forms control characters are used with the data, the table reference character follows the forms control character but precedes the data bytes. If forms control characters are not used, the table reference character is the first byte of the data record. As with forms control character, if table reference characters are used, every data record must contain a TRC byte.

Top

Page definition (PAGDFN)

Specifies the page definition to be used to format line data.

You can specify a page definition with *LINE, *AFPDSLINE, or *USERASCII data. PSF for i5/OS will convert the line data and page definition to IPDS.

When you specify a page definition on the printer file, some printer file parameters will be ignored when the spooled file is printed by PSF for i5/OS. The following print file parameters will be ignored:

Single values

*SAME
The value does not change.
*NONE
No page definition is specified.

Because PSF for i5/OS requires a page definition when *LINE or *AFPSDLINE is specified, an inline page definition is built from the print file parameters and passed to PSF for i5/OS when *NONE is specified.

Qualifier 1: Page definition

name
Specify the name of the page definition that must exist in the library specified. Valid values range from 1 to 8 characters. Device type *AFPDSLINE, *LINE, or *USERASCII must be specified when using a page definition.

Qualifier 2: Library

*LIBL
All libraries in the library list for the current thread are searched until the first match is found.
*CURLIB
The current library for the thread is searched. If no library is specified as the current library for the thread, the QGPL library is searched.
name
Specify the name of the library to be searched.
Top

Form definition (FORMDF)

Specifies the form definition to use when printing the file. A form definition is a resource object that defines the characteristics of the form, including overlays, position of page data on the form, and number of copies of pages and modifications to pages. The form definition is located inline with the file being printed, or in a library.

When you specify a form definition (*DEVD or form definition name) on the printer file, some printer file parameters will be ignored when the spooled file is printed by PSF for i5/OS. The following print file parameters will be ignored:

Single values

*SAME
The value does not change.
*NONE
No form definition is used.

Because PSF for i5/OS requires a form definition, an inline form definition is built from the print file parameters and passed to PSF for i5/OS when *NONE is specified.

*DEVD
The name of the form definition is specified in the printer device description.

Qualifier 1: Form definition

name
Specify the name of the form definition that must exist in the library specified. Valid values range from 1 to 8 characters.

Qualifier 2: Library

*LIBL
All libraries in the library list for the current thread are searched until the first match is found.
*CURLIB
The current library for the thread is searched. If no library is specified as the current library for the thread, the QGPL library is searched.
name
Specify the name of the library to be searched.
Top

AFP Characters (AFPCHARS)

Specifies one or more AFP characters (coded fonts) to be used with line data and a page definition.

Single values

*SAME
The value does not change.
*NONE
No AFP characters (coded fonts) specified.

Other values (up to 4 repetitions)

character-value
Specify up to four 4-byte names of coded fonts to be specified with the line data and a page definition. The 4-byte names are concatenated to X0 to identify up to four coded fonts which are to be used when TBLREFCHR is being used within the data.
Top

Degree of page rotation (PAGRTT)

Specifies the degree of text rotation for the 3112, 3116, 3130, 3812, 3816, 4028, 3820, 3825, 3827, 3829, 3831, 3835, 3900, 3916, 3930 and 3935 printers. This parameter allows the user to specify the degree of rotation of the text on the page with respect to the way the form is loaded into the printer. See the note under the PAGESIZE parameter for directions on specifying page size when rotating the page.

Specify *AUTO or *DEVD for this parameter and PRTQLTY(*DRAFT) on this command to enable automatic rotation if the data does not fit on the paper.

*SAME
The value does not change.
*AUTO
Indicates that automatic rotation of output is done to fit the printed data on the form. If rotation does not accomplish this, computer output reduction is performed automatically (regardless of the print quality being used). This parameter is valid only for printers supporting rotation.
*DEVD
The operating system sends a device default rotation value to the printer. Page rotation is dependent on your printer's specifications. See your printer or printer emulation documentation to determine how page rotation is affected.
*COR
Computer output reduction is done. Computer output reduction allows output intended for a 13.2 inch wide by 11.0 inch long form to be printed on an 8.5 inch wide by 11.0 inch long form.

For computer output reduction printing, the following operations are done for the 3112, 3116, 3130, 3812, 3816, 4028, 3820, 3825, 3827, 3829, 3831, 3835, 3900, 3916, 3930 and 3935 printers:

  • Automatic rotation to *COR is not done if the file contains graphics, bar codes, variable LPI, variable font, variable page rotations, or variable drawer.
  • The text is rotated 90 degrees clockwise from the 0 degree rotation position (lower left corner of the first edge loaded into the printer).

    Note: For landscape paper on a 3835 printer, the rotation is counter-clockwise from the 0 degree rotation position (upper right corner of the first edge loaded into the printer).

  • A top and left margin of 0.5 inches is added to the printed output.
  • The 12-pitch fonts are changed to a 15-pitch font and 15-pitch fonts are changed to a 20-pitch font. All other font widths are changed to a 13.3-pitch font, except for the 4028 printer where they are changed to a 15-pitch font.
  • Vertical spacing (specified by the LPI parameter) is 70 percent of the normal spacing.
  • The page size is set to 8.5 inches wide by 11 inches long.
0
No rotation is done. Printing starts at the edge 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.
Top

Pages per side (MULTIUP)

Specifies, for spooled output only, whether or not multiple pages of output are printed on 1 physical page.

Note: Overlays are not reduced when more than one page is printed on a side.

For more information and examples see the Printing category in the IBM i Information Center at http://www.ibm.com/systems/i/infocenter/.

*SAME
The number of pages of output per physical page does not change.
1
One page of output is printed on each physical page.
2
Two pages of output are printed on each physical page.
3
Three pages of output are printed on 1 physical sheet of paper.
4
Four pages of output are printed on each physical page.
Top

Reduce output (REDUCE)

Specifies whether or not to reduce the output when doing multiple up printing.

For more information and examples see the Printing category in the IBM i Information Center at http://www.ibm.com/systems/i/infocenter/.

*SAME
The value does not change.
*TEXT
The text output is reduced when doing multiple up printing.
*NONE
The output is not reduced when doing multiple up printing.
Top

Print text (PRTTXT)

Specifies the text that is printed at the bottom of each page of printed output and on separator pages.

*SAME
This value does not change.
*JOB
The text is obtained from the job attribute.
*BLANK
No text is specified.
character-value
Specify no more than 30 characters of text, enclosed in apostrophes.
Top

Hardware justification (JUSTIFY)

Specifies the printing positions of the characters on a page so that the right-hand margin of printing is regular. Justification is done to the record length on the printer file opened.

Note: The JUSTIFY parameter is supported only on the 3812 SCS, 3816 SCS, and 5219 SCS printers.

*SAME
This value does not change.
0
No justification occurs. This is the default value for this parameter on the CRTPRTF command.
50
Spaces are added to the blanks in the text so that the right margin is more closely aligned, but not flush.
100
The text is expanded by spaces until the right margin is flush.
Top

Print on both sides (DUPLEX)

Specifies whether output is printed on one side or two sides of the paper.

*SAME
This value does not change.
*NO
The output is printed on one side of the paper.
*YES
The output is printed on both sides of the paper, with the top of each printed page at the same end of the sheet of paper. This is usually used for printed output that is bound at the side of the sheet.
*TUMBLE
The output is printed on both sides of the paper, with the top of one printed page at the opposite end from the top of the other printed page. This is usually used for printed output that is bound at the top of the sheet.
*FORMDF
The output is printed on both sides of the paper if the duplex value is specified in the form definition. If a form definition is not specified, then the output is printed on one side of the paper.
Top

Defer write (DFRWRT)

Specifies whether output is held in the system buffer before being sent to the printer.

*SAME
The value does not change.
*YES
The system controls the amount of output that is held in the buffer before it is sent to the printer.

If SPOOL(*YES) is specified along with SCHEDULE(*IMMED), output is held in the buffer until a page of output is available or until the system buffer is full.

*NO
If *NO is specified for this parameter and *NO is specified for the Spool the data (SPOOL) parameter, output is not held in the buffer. Instead, output is sent immediately to the printer once the program has performed a write operation.

If *NO is specified for this parameter and *YES is specified for the SPOOL parameter and if *IMMED is specified for the Spooled output schedule (SCHEDULE) parameter, output is held in the buffer until a page of output is available or until the system buffer is full.

If *IMMED is not specified for the SCHEDULE parameter, specifying *NO on this parameter has no effect.

Top

Unit of measure (UOM)

Specifies the unit of measurement to be used.

*SAME
The unit of measurement does not change.
*INCH
The inch is used as the unit of measurement.
*CM
The centimeter is used as the unit of measurement.
Top

Front side overlay (FRONTOVL)

Specifies the object that contains both the overlay that is printed on the front side of the page and the offset, down and across, from the point of origin used when the overlay is printed.

Single values

*NONE
No overlay is used.

Element 1: Overlay

Single values

*SAME
The value does not change.

Qualifier 1: Overlay

name
Specify the name of the overlay.

Qualifier 2: Library

*LIBL
All libraries in the library list for the current thread are searched until the first match is found.
*CURLIB
The current library for the job is used to locate the overlay. If no library is specified as the current library for the job, the QGPL library is used.
name
Specify the name of the library where the overlay is located.

Element 2: Offset down

*SAME
The offset down from the point of origin does not change.
0.0-57.79
Specify the offset down from the point of origin at which to begin printing the overlay. If UOM(*CM) is specified, valid values range from 0 through 57.79, and if UOM(*INCH) is specified, valid values range from 0 through 22.75.

Element 3: Offset across

*SAME
The offset across from the point of origin does not change.
0.0-57.79
Specify the offset across from the point of origin at which to begin printing the overlay. If UOM(*CM) is specified, valid values range from 0 through 57.79, and if UOM(*INCH) is specified, valid values range from 0 through 22.75.
Top

Back side overlay (BACKOVL)

Specifies the object that contains both the overlay that is printed on the back side of the page and the offset, down and across, from the point of origin used when the overlay is printed.

The constant back function allows you to print overlays on blank pages without adding blank pages to the print application. Specifying the constant back function would cause, for each page generated by the application program, a blank page to be generated onto which the specified back overlay could be printed. The generated blank pages are called constant forms because no variable data from the user's program is printed on the pages. The constant back function is only supported for duplex printing. It is ignored when DUPLEX(*NO) is specified on the printer file.

Note that the offset down and offset across values are ignored when *CONSTANT is specified for constant back. An offset of 0.0 is assumed for these values.

Single values

*FRONTOVL
The values specified for the Front side overlay (FRONTOVL) parameter are used.
*NONE
No overlay is used.

Element 1: Overlay

Single values

*SAME
The value does not change.

Qualifier 1: Overlay

name
Specify the name of the overlay.

Qualifier 2: Library

*LIBL
All libraries in the library list for the current thread are searched until the first match is found.
*CURLIB
The current library for the job is used to locate the overlay. If no library is specified as the current library for the job, the QGPL library is used.
name
Specify the name of the library where the overlay is located.

Element 2: Offset down

*SAME
The offset down from the point of origin does not change.
0.0-57.79
Specify the offset down from the point of origin at which to begin printing the overlay. If UOM(*CM) is specified, valid values range from 0 through 57.79, and if UOM(*INCH) is specified, valid values range from 0 through 22.75.

Element 3: Offset across

*SAME
The offset across from the point of origin does not change.
0.0-57.79
Specify the offset across from the point of origin at which to begin printing the overlay. If UOM(*CM) is specified, valid values range from 0 through 57.79, and if UOM(*INCH) is specified, valid values range from 0 through 22.75.

Element 4: Constant back

*SAME
The value does not change.
*NOCONSTANT
No constant back is specified.
*CONSTANT
Constant back is specified.
Top

Convert line data (CVTLINDTA)

Specifies whether line data and a page definition should be converted to AFPDS before the data is spooled.

*NO
No AFPDS conversion is done.
*YES
Specifies that AFPDS conversion is to be done on the line data and page definition before the data is spooled.
Top

IPDS pass through (IPDSPASTHR)

Specifies whether IPDS (intelligent printer data stream) pass-through is done for the spooled file.

*SAME
The value does not change.
*DEVD
The value specified for IPDSPASTHR in the PSF configuration object specified for a printer device description is used. If no PSF configuration object is specified for the device, a value of *NO is used.
*NO
No IPDS pass-through is done.
*YES
Specifies that IPDS pass-through is to be done if the spooled file is eligible for IPDS pass-through.

Note: 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. Specifying IPDS pass-through on the printer file allows only those spooled files eligible for IPDS pass-through to bypass the extra transforms. Those spooled files not eligible for IPDS pass-through will still undergoes the transforms to AFPDS and back to IPDS.

IPDS pass-through will not be valid for all PSF for i5/OS supported printers. Any printer (or attachment) that does not support resident fonts can not support IPDS pass-through. This is because the resident font references in the data stream must be mapped to host fonts which 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 OS/2's Distributed Print Function.

For V3R7, V4R1 and V4R2, IPDSPASTHR can be specified with the USRDFNDTA parameter in a printer file. You may continue using this support with existing printer files and PSF configuration objects by specifying IPDSPASTHR(*DEVD) in the printer file. If you specify a value of anything other than *DEVD for the IPDSPASTHR parameter, any IPDS pass-through value in the USRDFNDTA parameter is ignored.

Top

User resource library list (USRRSCLIBL)

Specifies the list of user resource libraries to be used for searching for AFP resources for a spooled file. If the AFP resource is not found in the user resource libraries, then the library list specified in the DEVRSCLIBL parameter of the PSF configuration object is searched. If no PSF configuration object is specified for the device, then libraries QFNTCPL, QFNT01-QFNT19, and QFNT61-69 are searched.

Single values

*SAME
The value does not change.
*DEVD
The value specified for USRRSCLIBL in the PSF configuration object specified for a printer device description is used. If no PSF configuration object is specified for the device, a value of *JOBLIBL is used.
*NONE
No user libraries are specified.
*JOBLIBL
Specifies that the library list of the job that created the spool file is used in searching for AFP resources. This library list is saved with the spool file when it is created.
*CURLIB
Specifies that the current library of the job that created the spool file is used for searching for AFP resources. If no library is specified as the current library for the job, then library QGPL is used.

Other values (up to 4 repetitions)

name
Specify the name of a library that will be used to search for AFP resources. Up to four library names may be specified.

For V3R7, V4R1 and V4R2, USRRSCLIBL can be specified with the USRDFNDTA parameter in a printer file. PSF for i5/OS uses that value if USRRSCLIBL(*PRTF) is specified in a PSF configuration object which is specified in the printer device description. You may continue using this support with existing printer files and PSF configuration objects by specifying USRRSCLIBL(*DEVD) in the printer file. If you specify a value of anything other than *DEVD for the USRRSCLIBL parameter, any user resource library value in the USRDFNDTA parameter i ignored.

Top

Corner staple (CORNERSTPL)

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. Page rotation does not affect the placement of a corner staple.

*SAME
The value does not change.
*NONE
A corner staple is not specified.
*DEVD
The reference corner is the default reference corner used by the device.
*BOTRIGHT
The reference corner is the bottom right corner of the media.
*TOPRIGHT
The reference corner is the top right corner of the media.
*TOPLEFT
The reference corner is the top left corner of the media.
*BOTLEFT
The reference corner is the bottom left corner of the media.
Top

Edge stitch (EDGESTITCH)

Specifies where one or more staples are driven into the media along the finishing operation axis. Refer to your printer's documentation for information about which elements of this parameter are supported and which values for each element are supported. If specification of a value for an element is not supported by a printer, specify a value of *DEVD for that element. Page rotation does not affect the placement of an edge stitch.

Single values

*NONE
An edge stitch is not specified.

Element 1: Reference edge

Specifies the reference edge to be used for an edge stitch. An edge stitch is formed by having one or more staples driven into the media along the finishing operation axis.

*SAME
The value does not change.
*DEVD
The reference edge is the default reference edge used by the device.
*BOTTOM
The reference edge is the bottom edge of the media.
*RIGHT
The reference edge is the right edge of the media.
*TOP
The reference edge is the top edge of the media.
*LEFT
The reference edge is the left edge of the media.

Element 2: Reference edge offset

Specifies the offset of the edge stitch from the reference edge toward the center of the media.

*SAME
The value does not change.
*DEVD
The reference edge offset is the default reference edge offset used by the device.
0.0-57.79
Specify the offset of the edge stitch from the reference edge. If UOM(*CM) is specified, valid values range from 0 through 57.79, and if UOM(*INCH) is specified, valid values range from 0 through 22.75. This value is converted to millimeters for the printer. Fractional millimeters are not supported and are discarded when when conversion to millimeters is performed.

Element 3: Number of staples

Specifies the number of staples that are to be applied along the finishing operation axis.

*SAME
The value does not change.
*DEVD
The number of staples depends on the value of the Staple Offsets element of this parameter. If *DEVD is also specified or defaulted for the Staple Offsets element value, then the number of staples is the default number of staples used by the device. If one or more offsets are specified for Staple Offsets, the number of staples is the same as the number of staple offsets specified.
1-122
Specify the number of staples to be used for the edge stitch. If you specify the number of staples, then *DEVD must be specified for staple offsets. The device default for the spacing of each staple will be used.

Element 4: Staple offsets

Specifies the offset of the staples along the finishing operation axis. The offset is measured from the point where the finishing operation axis intersects either the bottom edge or the left edge of the media, toward the center of the media. Each consecutive value is used to position a single finishing operation centered on the specified point on the finishing operation axis.

Single values

*SAME
The value does not change.
*DEVD
The staple offsets are the default staple positions used by the device. If a value was specified for the Number of Staples element, the staple position of each staple will be calculated automatically by the printer.

Other values (up to 122 repetitions)

0.0-57.79
Specify the staple offset for each staple in the edge stitch. Up to 122 staple offsets may be specified. If one or more staple offsets values are specified, then *DEVD must be specified for the number of staples. If UOM(*CM) is specified, valid values range from 0 through 57.79, and if UOM(*INCH) is specified, valid values range from 0 through 22.75. This value is converted to millimeters for the printer. Fractional millimeters are not supported and are discarded when when conversion to millimeters is performed.
Top

Saddle stitch (SADLSTITCH)

Specifies where one or more staples are driven into the media along the finishing operation axis, which is positioned at the center of the media parallel to the reference edge. Refer to your printer's documentation for information about which elements of this parameter are supported and which values for each element are supported. If specification of a value for an element is not supported by a printer, specify a value of *DEVD for that element. Page rotation does not affect the placement of an edge stitch.

Single values

*NONE
A saddle stitch is not specified.

Element 1: Reference edge

Specifies the reference edge to be used for a saddle stitch. A saddle stitch is formed by having one or more staples driven into the media along the finishing operation axis, which is positioned at the center of the media parallel to the reference edge.

*SAME
The value does not change.
*DEVD
The reference edge is the default reference edge used by the device.
*TOP
The reference edge is the top edge of the media.
*LEFT
The reference edge is the left edge of the media.

Element 2: Number of staples

Specifies the number of staples that are to be applied along the finishing operation axis.

*SAME
The value does not change.
*DEVD
The number of staples depends on the value of the Staple Offsets element of this parameter. If *DEVD is also specified or defaulted for the Staple Offsets element value, then the number of staples is the default number of staples used by the device. If one or more offsets are specified for Staple Offsets, the number of staples is the same as the number of staple offsets specified.
1-122
Specify the number of staples to be used for the saddle stitch. If you specify the number of staples, then *DEVD must be specified for staple offsets. The device default for the spacing of each staple will be used.

Element 3: Staple offsets

Specifies the offset of the staples along the finishing operation axis. The offset is measured from the point where the finishing operation axis intersects either the bottom edge or the left edge of the media, toward the center of the media. Each consecutive value is used to position a single finishing operation centered on the specified point on the finishing operation axis.

Single values

*SAME
The value does not change.
*DEVD
The staple offsets are the default staple positions used by the device. If a value was specified for the Number of Staples element, the staple position of each staple will be calculated automatically by the printer.

Other values (up to 122 repetitions)

0.0-57.79
Specify the staple offset for each staple in the saddle stitch. Up to 122 staple offsets may be specified. If one or more staple offsets values are specified, then *DEVD must be specified for the number of staples. If UOM(*CM) is specified, valid values range from 0 through 57.79, and if UOM(*INCH) is specified, valid values range from 0 through 22.75. This value is converted to millimeters for the printer. Fractional millimeters are not supported and are discarded when when conversion to millimeters is performed.
Top

Font resolution for formatting (RNTRSL)

Specifies the resolution PSF for i5/OS uses when printing to a multiple resolution printer configured to report multiple resolutions, but the spooled file does not specify the font metrics and resolution or the font is not available at the resolution that is contained in the spooled file.

For more information regarding the algorithm used for searching a library list for a font resource, see the Printing category in the IBM i Information Center at http://www.ibm.com/systems/i/infocenter/. manual section entitled User and Device Resource Library Lists in the chapter called Working With PSF configuration objects.

*SAME
The value does not change.
*DEVD
The value specified in the FNTRSL parameter of the PSF configuration object for the device is used. If no PSF configuration object is specified for the device, a value of *SEARCH is used.
*SEARCH
Specifies to search the library list for the first occurrence of a host font with a name match. The resolution of that font is used to print the spool file. Message PQT3546 is sent to specify the resolution of the font that was selected.
240
The font resolution is 240 pels per inch.
300
The font resolution is 300 pels per inch.
Top

Spool the data (SPOOL)

Specifies whether the output data for the printer device file is spooled. This parameter is ignored when the To stream file (TOSTMF) parameter value is not *NONE.

*SAME
This value does not change.
*YES
The data is spooled to a diskette writer or to a printer writer queue for later processing.
*NO
The data is not spooled. It is sent directly to the device and printed as the output becomes available.
Top

Spooled output queue (OUTQ)

Specifies the output queue (*OUTQ) object.

Single values

*SAME
The output queue does not change.
*JOB
The output queue associated with this job is used for the spooled output.
*DEV
The output queue associated with the printer specified for the Device (DEV) parameter is used. The output queue has the same name as the printer.

Qualifier 1: Spooled output queue

name
Specify the name of the output queue.

Qualifier 2: Library

*LIBL
All libraries in the library list for the current thread are searched until the first match is found.
*CURLIB
The current library for the job is used to locate the output queue. If no library is specified as the current library for the job, QGPL is used.
name
Specify the name of the library where the output queue is located.
Top

Form type (FORMTYPE)

Specifies the type of forms used in the printer.

*SAME
The type of printer form does not change.
*STD
The standard printer form for your computer system is used.
character-value
Specify the identifier of the type of printer form used with this device file for printed output.
Top

Copies (COPIES)

Specifies, for spooled output only, the number of copies of the output being printed.

*SAME
The number of copies does not change.
1-255
Specify the number of copies to be printed.
Top

Expiration date for file (EXPDATE)

Specifies the expiration date for the spooled file. The spooled file will expire at 23:59:59, system local time on the date specified.

*SAME
The expiration date does not change.
*NONE
No expiration date is specified.
*DAYS
The expiration date is to be calculated using the value specified for the Days until file expires (DAYS) parameter.
date
Specify the date after which the spooled file will be eligible for removal from the system by the Delete Expired Spooled Files (DLTEXPSPLF) command. The date must be enclosed in apostrophes if date separator characters are used in the value.
Top

Days until file expires (DAYS)

Specifies the number of days to keep the spooled file.

Note: A value must be specified for this parameter if the Expiration date for file (EXPDATE) parameter has a value of *DAYS. If the EXPDATE parameter has a value other than *DAYS, no value is allowed for this parameter.

1-366
Specify an interval in days after which the spooled file will be eligible for removal from the system by the Delete Expired Spooled Files (DLTEXPSPLF) command. The actual expiration date applied to the spooled file is calculated by adding the number of days specified to the date the printer file is opened.
Top

Page range to print (PAGERANGE)

Specifies, for spooled output files only, the starting and ending pages to print.

Element 1: Starting page

*SAME
The starting page to print does not change.
*ENDPAGE
Use the end page value as the starting page.
integer
Specify the starting page number.

Element 2: Ending page

*SAME
The ending page to print does not change.
*END
Printing continues until the end of the spooled file.
integer
Specify the ending page number.
Top

Max spooled output records (MAXRCDS)

Specifies, for spooled output only, the maximum number of records that can be in the spooled file for spooled jobs using this printer file.

*SAME
The maximum number of records does not change.
*NOMAX
There is no maximum on the number of records that can be in the spooled file.
1-99999999
Specify the maximum number of records allowed.
Top

File separators (FILESEP)

Specifies, for spooled output files only, the number of separator pages placed at the start of each printed file, including those between multiple copies of the same output. Each separator page has the following items printed on it: file name, file number, job name, user name, and job number.

*SAME
The number of separator pages does not change.
0-9
Specify the number of separator pages to be placed between printed files. If 0 is specified, no separator pages are printed for the file. In this case, the printed output for each file (or copy of a file) starts at the top of a new page.
Top

Spooled output schedule (SCHEDULE)

Specifies, for spooled output files only, when the spooled output file is made available to a diskette writer.

*SAME
The time when spooled output starts does not change.
*JOBEND
The spooled output file is made available after the job is completed.
*FILEEND
The spooled output file is made available when the file is closed in the program.
*IMMED
The spooled output file is made available to the writer as soon as the file is opened in the program.
Top

Hold spooled file (HOLD)

Specifies, for spooled output files only, whether the spooled file is held. The spooled file can be released by using the Release Spooled File (RLSSPLF) command.

*SAME
The spooled file status does not change.
*NO
The spooled output file is not held by the output queue.
*YES
The spooled output file is held until it is released by the Release Spooled File (RLSSPLF) command.
Top

Save spooled file (SAVE)

Specifies, for spooled output files only, whether the spooled file is saved (kept on the output queue) after the output has been produced.

*SAME
The spooled file status does not change.
*NO
The spooled file data is not kept on the output queue.
*YES
The spooled file data is kept on the output queue until the file is deleted. After the file is produced, the number of copies (see Copies (COPIES) parameter) is set to 1, and its status is changed from WTR to SAV. Refer to the Release Spooled File (RLSSPLF) command for information on how to produce the spooled file again.
Top

Output priority (on OUTQ) (OUTPTY)

Specifies the output priority for spooled output files that are produced by this job. The highest priority is 1 and the lowest priority is 9.

*SAME
The output priority does not change.
*JOB
The output priority associated with the job that created the spooled file is used.
1-9
Specify the output priority with a number ranging from 1 (high) through 9 (low).
Top

User data (USRDTA)

Specifies, for spooled output, user-specified data that identifies the file.

*SAME
The value does not change.
*SOURCE
If the spooled file was created by an application program, the name of that program is used. Otherwise, blanks are used.
character-value
Specify up to 10 characters of text.
Top

Spool file owner (SPLFOWN)

Specifies, for spooled output only, who the owner of the spooled file is.

*SAME
The value does not change.
*CURUSRPRF
The spooled file is owned by the current effective user of the current job or thread. See the Printing category in the IBM i Information Center at http://www.ibm.com/systems/i/infocenter/ for more detailed information on how the SPLFOWN parameter is affected when using any of the following APIs:
  • QWTSETP - Set Profile
  • qsysetuid() - Set User ID
  • qsyseteuid() - Set Effective User ID
  • qsysetreuid() - Set Real and Effective User ID
*JOB
The spooled file is owned by the original user profile of the job. If the job has switched to a new user profile, the original user profile is still the owner of the spooled file.
*CURGRPPRF
The spooled file is owned by the current effective group profile of the current job or thread. If there is no current effective group profile, ownership of the spooled file is determined in the same manner as *CURUSRPRF. See the Printing category in the IBM i Information Center at http://www.ibm.com/systems/i/infocenter/ for more detailed information on how the SPLFOWN parameter is affected when using any of the following APIs:
  • QWTSETP - Set Profile
  • qsysetgid() - Set Group ID
  • qsysetegid() - Set Effective Group ID
  • qsysetregid() - Set Real and Effective Group ID
*JOBGRPPRF
The spooled file is owned by the group profile of the original user profile of the job. If the job has switched to a new user profile, the group profile of the original user profile is still the owner of the spooled file. If no group profile exists, ownership of the spooled file is determined the same way as *JOB.
Top

User Defined Option (USRDFNOPT)

Specifies, for spooled output only, one or more user-defined options to be used by user applications or user-specified programs that process spooled files. A maximum of four user-defined options can be specified.

Single values

*SAME
The value does not change.
*NONE
No user-defined options specified.

Other values (up to 4 repetitions)

character-value
Specify a user-defined option to be used by user applications or user-specified programs that process spooled files. All characters are acceptable.
Top

User Defined Data (USRDFNDTA)

Specifies, for spooled output only, the user-defined data to be used by user applications or user-specified programs that process spooled files.

*SAME
The value does not change.
*NONE
No user-defined data specified.
character-value
Specify a user-defined data to be used by user applications or user-specified programs that process spooled files. All characters are acceptable.
Top

User Defined Object (USRDFNOBJ)

Specifies, for spooled output only, the user-defined object to be used by user applications or user-specified programs that process spooled files.

Single values

*SAME
The value does not change.
*NONE
No user-defined object specified.

Element 1: Object

Qualifier 1: Object

name
Specify the user-defined object to be used by user applications or user-specified programs that process spooled files.

Qualifier 2: Library

*LIBL
All libraries in the library list for the current thread are searched until the first match is found.
*CURLIB
The current library for the thread is searched. If no library is specified as the current library for the thread, the QGPL library is searched.
name
Specify the name of the library to be searched.

Element 2: Object type

object-type
The user object type can be one of the following:
*DTAARA
Data Area
*DTAQ
Data Queue
*FILE
File
*PSFCFG
PSF Configuration Object
*USRIDX
User Index
*USRQ
User Queue
*USRSPC
User Space
Top

User specified DBCS data (IGCDTA)

Specifies, for program-described files, whether the file processes double-byte character set (DBCS) data. Specifies, for externally described files, the DBCS attributes of the file.

For Program-Described Files

*SAME
The value does not change.
*NO
The file does not process double-byte character set (DBCS) data.
*YES
The file processes double-byte character set (DBCS) data.

For Externally-Described Files

*SAME
The value does not change.
*NO
The double-byte character set (DBCS) attributes of the file are defined in the data description specifications (DDS).
*YES
DBCS attributes in addition to those defined in the DDS include: (1) putting the DDS keyword for alternative data type (IGCALTTYP) into effect and (2) identifying double-byte character attributes of fields or messages not identified in the DDS.
Top

DBCS extension characters (IGCEXNCHR)

Specifies whether the system processes double-byte character set (DBCS) extension characters.

Specifies whether the system processes double-byte character set (DBCS) extended characters. When processing DBCS extended characters, the device requires the assistance of the system. The system must tell the device what the character looks like before the device can display or print the character. Extended characters are stored in a DBCS font table, not in the DBCS device. Extended character processing is a function of the operating system that is required to make characters stored in a DBCS font table available to a DBCS device.

*SAME
The value does not change.
*YES
The system processes DBCS extended characters.
*NO
The system does not process DBCS extended characters. It prints extended characters as the undefined character.
Top

DBCS character rotation (IGCCHRRTT)

Specifies whether the printer rotates the double-byte character set (DBCS) characters 90 degrees counterclockwise when printing. The system prints rotated DBCS characters so that they appear in a vertical reading sequence. Alphanumeric characters are not rotated.

*SAME
The value does not change.
*NO
The system does not rotate DBCS characters when printing.
*YES
The system rotates DBCS characters 90 degrees counterclockwise when printing. The printer rotates each character individually.
Top

DBCS characters per inch (IGCCPI)

Specifies the printer character density of double-byte character set (DBCS) data in characters per inch (CPI).

Note: This parameter does not specify the printer character density of alphanumeric characters. Alphanumeric characters are printed with the value specified on the CPI parameter.

*SAME
This value does not change.
*CPI
DBCS character density is based on the values specified for the Characters per inch (CPI) parameter. *CPI is the default value for this parameter on the CRTPRTF command.
  • For CPI(10), DBCS characters print at 5 characters per inch.
  • For CPI(12), DBCS characters print at 6 characters per inch.
  • For CPI(13.3), DBCS characters print at 6.7 characters per inch.
  • For CPI(15), DBCS characters print at 7.5 characters per inch.
5
DBCS character density is 5 CPI.
6
DBCS character density is 6 CPI.
10
DBCS character density is 10 CPI.
*CONDENSED
Condensed printing is used in which the system prints 20 DBCS characters every 3 inches. This value is valid only for the 5553 or 5583 printers.
Top

DBCS SO/SI spacing (IGCSOSI)

Specifies how the system prints shift-in and shift-out characters.

*SAME
This value does not change.
*NO
The system does not print shift control characters. These characters do not occupy a position on printer output.
*YES
The system prints shift control characters as blanks.
*RIGHT
The system prints two blanks when printing shift-in characters, but it does not print shift-out characters.
Top

DBCS coded font (IGCCDEFNT)

Specifies the coded font that the system uses for double-byte character set (DBCS) printing.

Single values

*SAME
This value does not change.
*SYSVAL
The DBCS coded font specified in the system value QIGCCDEFNT is used.

Element 1: DBCS coded font

Qualifier 1: DBCS coded font

name
Specify name of the DBCS coded font to use.

Qualifier 2: Library

*LIBL
All libraries in the library list for the current thread are searched until the first match is found.
*CURLIB
The current library for the job is used to locate the coded font name. If no library is specified as the current library for the job, the QGPL library is used.
name
Specify the name of the library where the coded font name is located.

Element 2: Point size

*NONE
The point size is supplied by the system and is determined by the specified font character set.
0.1-999.9
Specify a point size.
Top

To stream file (TOSTMF)

Specifies the directory or stream file where the output data is to be written. All directories in the path name must exist. New directories are not created. This parameter is only valid when the Workstation customizing object (WSCST) parameter is not *NONE, or the Printer device type (DEVTYPE) parameter is *AFPDS.

If the TOSTMF value refers to a directory, the system will create a stream file in that directory with a unique name derived from the printer file name. If the TOSTMF value is a file name, a stream file by that name must not already exist.

*SAME
The value does not change.
*NONE
The output is written to a spooled file if the SPOOL parameter is *YES, or directly to the printer device (DEV) if the SPOOL parameter is *NO.
path-name
Specify the path name for the directory or stream file where you want the output data to be written.
Top

Workstation customizing object (WSCST)

Specifies the workstation customizing object to use to transform the printer file output to final form before writing it to a stream file. This parameter is only valid when the To stream file (TOSTMF) parameter is not *NONE.

Single values

*SAME
The value does not change.
*NONE
The output is not transformed to final form before writing to a stream file.
*PDF
The output is transformed to Portable Document Format (PDF) before it is written into a stream file.

Qualifier 1: Workstation customizing object

name
Specify the name of the customizing object.

Qualifier 2: Library

*LIBL
All libraries in the library list for the current thread are searched until the first match is found.
*CURLIB
The current library for the thread is searched. If no library is specified as the current library for the thread, the QGPL library is searched.
name
Specify the name of the library to be searched.
Top

Maximum file wait time (WAITFILE)

Specifies the number of seconds that the program waits for the file resources to be allocated when the file is opened, or the device or session resources to be allocated when an acquire operation is performed to the file. If the file resources cannot be allocated in the specified wait time, an error message is sent to the program.

*IMMED
The program does not wait. Immediate allocation of file resources is required.
*CLS
The job default wait time is used as the wait time for the file resources to be allocated.
1-32767
Specify the number of seconds to wait for file resources to be allocated.
Top

Share open data path (SHARE)

Specifies whether the open data path (ODP) is shared with other programs in the same routing step. When an ODP is shared, the programs accessing the file share facilities such as the file status and the buffer.

*SAME
This value does not change.
*NO
The ODP is not shared with other programs in the routing step. A new ODP for the file is created and used every time a program opens the file.
*YES
The same ODP is shared with each program in the job that also specifies *YES when it opens the file.
Top

Examples

Example 1: Changing Two Parameters

CHGPRTF   FILE(ACCREC/PRTRPT)  LPI(6)  ALIGN(*YES)

This command changes two parameters in printer file PRTRPT stored in library ACCREC. The system operator must align the pages in the printer before the system starts printing the file. The file is printed in 6 lines per inch on the pages.

Example 2: Changing All IBM-Supplied Printer Files

CHGPRTF   FILE(QSYS/Q*)  PAGESIZE(88 132)  LPI(8)  OVRFLW(80)

This command changes all IBM-supplied printer files (that is, all printer files in library QSYS whose names start with a Q) to use 88 lines of 132 characters (8 lines per inch), but to skip to the next page after 80 lines.

Example 3: Processing DBCS Data

CHGPRTF   FILE(IGCLIB/IGCPRT)  FORMFEED(*AUTOCUT)
          IGCDTA(*YES)  IGCCHRRTT(*YES)

This command changes printer file IGCPRT stored in library IGCLIB, so that it processes double-byte character set data. The system rotates double-byte characters before printing, and cut sheets are fed automatically when printing.

Top

Error messages

*ESCAPE Messages

CPF339F
Expiration date must be today or a date in the future.
CPF7304
File &1 in &2 not changed.
CPF7308
&5 files not changed for &1 in &2. &4 files changed.
Top