Override with Printer File (OVRPRTF)

The Override with Printer File (OVRPRTF) command is used to (1) override (replace) the file named in the program, (2) override certain parameters of a file that are used by the program, or (3) override the file named in the program and override certain parameters of the file processed. Parameters overridden by this command are specified in the file description, in the program, or in other file override commands that run in the following command.

If a file named in the program is overridden, the name of that file is specified in the FILE parameter and the name of the overriding file (the file processed) is specified in the TOFILE parameter. The OVRPRTF command also specifies parameters to override values contained in the file description of the overriding file. If the file named in the program is not replaced but certain parameters of the file are overridden, the name of the file is specified in the FILE parameter and *FILE is specified in the TOFILE parameter. The parameters overridden are then specified by the other parameters of the OVRPRTF command. Parameters not specified do not affect parameters specified in the file description, in the program, or in other file override commands run later.

Restrictions:

• In a multithreaded job, this command may only be issued from the initial thread.
• In a multithreaded job, only Activation Group or Job scoped overrides will affect opens performed in a secondary thread.

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

Note: Using this command does not cause a file to be overridden immediately. Information provided on this command is stored until the file is used, at which time the file is overridden.

Parameters

File being overridden (FILE)

Specifies the file being used by the program to which this override command is applied. The specified file must be a printer device file when *FILE is specified in the Overriding to printer file (TOFILE) parameter. Otherwise, any device file name or database file name is specified.

This is a required parameter.

*PRTF

The *PRTF override is applied. This override applies to all printer files being opened except for those printer files that already have specific overrides. For example, if a *PRTF override is issued at call level 3, and an override is issued for QSYSPRT at call level 3, the *PRTF override is applied to all printer files being opened except for QSYSPRT since there is a specific override for it.

name

Specify the names of one or more overridden files for which the overrides in the call level are applied.

Overriding to printer file (TOFILE)

Specifies the printer file that is used instead of the file specified in the File being overridden (FILE) parameter; or, if *FILE is specified, specifies that certain attributes are overridden by parameters specified in this command. The parameters specified on this OVRPRTF command override the same parameters specified in the printer file, in the program, or in other called (OVRPRTF) commands.

Single values

*FILE

The printer device file named in the FILE parameter has some of its parameters overridden by values specified in this command.

Qualifier 1: Overriding to printer file

name

Specify the name of the printer device file that is used instead of the overridden file.

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 file. If no library is used as the current library for the job, QGPL is used.

name

Specify the library where the file is located.

Device (DEV)

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

*SYSVAL

The value in the system value QPRTDEV at the time the job is started is used as the printer device.

*JOB

The printer associated with the job is the printer device.

name

Specify the name of the device that is used with the printer file. The device name must already be known on the system by a device description.

Double-byte character set considerations: When printing a file that has double-byte character set (DBCS) data, specify a DBCS printer (5553, 5583).

Printer device type (DEVTYPE)

Specifies the type of data stream that is created for a printer device file. This parameter indicates whether the resulting data stream is an Intelligent Printer Data Stream (IPDS) or an SNA Character Stream (SCS).

*SCS

An SNA Character Stream (SCS) data stream is created.

Note: When using double-byte character set (DBCS) printers (the 5553 and 5583 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 AS/400 system does not change or validate the values that are passed. This value cannot be specified with SPOOL(*NO).

*AFPDS

An advanced function print 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).

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 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: Page length

0.001-255.0

Specify the page length used by this device file. Although a value ranging from .001 through 255 is allowed, the value specified should not exceed the actual length of the forms used.

Element 2: Page width

0.001-378.0

Specify the page width used by this device file. The value specified should not exceed the actual width of the page used. Valid values for the 3203, 4245, 5211, 5256, 5262, and 3287 printers range from 1 through 132.

Element 3: Measurement method

*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 on the UOM parameter.

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, 4230, 4234, 4245, and 5262 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.

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.

6

The line spacing on the printer is 6 lines per inch. This is the default value for this parameter on the CRTPRTF command.

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: When printing a file that has double-byte character set (DBCS) data, specify a DBCS printer (5553, 5583).

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

5

Character density is 5 characters per inch.

10

Character density is 10 characters per inch. (This is the default value for this parameter on the CRTPRTF command.)

12

Character density is 12 characters per inch.

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.

Double-byte character set considerations: When printing a file that has double-byte character set (DBCS) data, specify a DBCS printer (5553, 5583).

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

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

Element 2: Offset across

0.0-57.79

Specify the offset of the origin from the left side of the page.

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. 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.57. This parameter can only be used for printer files with DEVTYPE(*AFPDS) specified.

Single values

*FRONTMGN

The offsets specified on the 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.

Element 2: Offset across

offset-across

Specify the offset of the origin from the left side of the page.

Overflow line number (OVRFLW)

Specifies the line number on the page at which overflow to a new page occurs. Generally, after the specified line is printed, the printer overflows to the next page before printing continues. Overflow is signaled when the specified line number is made the current line, whether printing has occurred on that line or not. The value specified must not exceed the forms length specified in the Page size (PAGESIZE) parameter for the file. 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/. This parameter overrides the overflow value specified in the printer file, in the program, or in other called OVRPRTF commands.

1-255

Specify the line number on the current page at which overflow to a new page begins, whether or not printing has occurred on that line. The value specified must not be greater than the page length (PAGESIZE). Margins specified for the printer file are ignored when determining overflow.

Fold records (FOLD)

Specifies whether all positions in a record are printed when the record length exceeds the form width. If so, any portion of the record that cannot be printed on the first line is continued (folded) on the next line or lines until the entire record is printed.

The FOLD parameter is ignored under the following conditions:

• When DEVTYPE(*SCS) is not specified.
• When printing through the OfficeVision program.
• When in the S/36 processing environment.

*YES

Records whose length exceeds the form width are folded on the following lines.

*NO

Records are not folded; if a record is longer than the form width, only the first part of the record that fits on one line is printed.

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 form width, the system continues printing the record on the next line.

This parameter overrides the value specified in the printer file, in the program, or in other called OVRPRTF commands.

Unprintable character action (RPLUNPRT)

Specifies whether unprintable characters are replaced and which substitution character (if any) is used. An unprintable character is a character that the printer is unable to print.

Note: If *IPDS is specified in the Printer device type (DEVTYPE) parameter, a hyphen (-) is printed for the unprintable characters. The substitution character is ignored for the 3287 printer.

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

*YES

Unprintable characters are replaced. The program is not notified when unprintable characters are detected.

Element 2: Replacement character

*BLANK

A blank is used as the substitution character when an unprintable character is detected and *YES is specified.

X'40'-X'FE'

Specify the substitution character that is used each time an unprintable character is detected if *YES is also specified in this parameter. Any printable EBCDIC character can be specified.

Double-byte character set considerations: The system ignores the chosen replacement character when you specify *YES. Instead, the system replaces unprintable characters as follows:

1. If *YES is also specified in the DBCS extension characters (IGCEXNCHR) parameter, the system replaces unprintable characters with double-byte character set (DBCS) underscores.
2. If *NO is specified in the IGCEXNCHR parameter, the system replaces all extension characters with the undefined character.

Align page (ALIGN)

Specifies whether the forms must be aligned in the printer before printing is started. If *YES is specified and *NO is specified in the Spool the data (SPOOL) parameter, and forms alignment is required, the system sends a message to the message queue specified for the printer, and waits for a reply to the message. If *YES is specified on the SPOOL parameter, and *FILE is specified on the Align page (ALIGN) parameter, of the Start Printer Writer (STRPRTWTR) command, this parameter is used to determine whether an alignment message should be 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.

*NO

No forms alignment is required.

*YES

The forms are aligned before the output is printed.

Source drawer (DRAWER)

Specifies the source drawer used when single-cut sheets are fed into the printer. *AUTOCUT must be specified on the Form feed (FORMFEED) parameter.

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

Output bin (OUTBIN)

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

*DEVD

The destination of the output is the device default output bin.

1-65535

Specify the output bin for the destination of the output.

Font specifications (FONT)

Specifies the font identifier and point size used with this printer device file. If a font identifier and point size is not specified, the system automatically sets them.

Single values

*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 being used with this printer device file.

Element 2: Point size

*NONE

No point size is specified; the system sets one based on the type of printer being used.

0.1-999.9

Specify a point size.

Form feed (FORMFEED)

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

*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 put on the printer if this value is specified.

*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 loaded manually. For cut sheets, the forms alignment message is not issued.

*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. For cut sheets, the forms alignment message is not issued.

Print quality (PRTQLTY)

Specifies, for the 3812 SCS, 3816 SCS, 4214, 4224, 4230, 4234, and 5219 printers, the quality of print produced.

For the 5219 Printer, different print qualities are produced by varying the speed at which the print ribbon advances. Quality mode (*STD or *NLQ) results in normal print ribbon advancement. In draft mode (*DRAFT), the ribbon advances at a rate of one-third the distance it advances in quality mode. In other words, the 5219 Printer conserves printer ribbon when in draft mode by not advancing it as fast per character printed. The 5219 Printer has a conserve ribbon switch that overrides the value of *DRAFT specified by this parameter.

For the 3812 SCS and 3816 SCS Printers, the automatic hardware selection of computer output reduction printing selected through soft switches on the printers occurs only when *DRAFT is specified for PRTQLTY and PAGRTT is *DEVD. If PAGRTT(*COR) is specified, the PRTQLTY parameter does not affect the printed output.

For the 4224, 4230, and 4234 Printers, standard print quality is produced by varying the density of the dot matrix pattern used to create printable characters. Standard mode (*STD) is the normal mode. Quality mode (*NLQ) requires multiple passes by the printer to produce a line of data. Draft mode (*DRAFT) results in high-speed printing.

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

NOTES:

• For the 4214 Printer, quality mode (*STD or *NLQ) is only supported for 10 and 12 characters per inch. If PRTQLTY(*STD or *NLQ) and 5, 15, or 16.7 characters per inch is specified, the data is printed in draft mode.
• For the 4234 Printer, only a limited character set (62 characters) is supported when PRTQLTY(*DRAFT) is specified. A description of the character set supported with draft print quality is in the 4234 Printer Operator's Guide.
• For the 4224 and 4230 printers, the fonts supported are not available for all three print qualities. The OCR-A and OCR-B fonts are supported only with PRTQLTY(*NLQ). The Courier and Essay fonts are available only with PRTQLTY(*NLQ) and PRTQLTY(*STD). The Gothic font is available only with PRTQLTY(*DRAFT) or PRTQLTY(*FASTDRAFT). If there is a mismatch between the print quality and the font selected, the font is changed to match the print quality.
• Specify PAGRTT(*DEVD) and PRTQLTY(*DRAFT) on this command to enable automatic rotation if the data does not fit on the paper.

*STD

The output is printed with standard quality.

*DRAFT

The output is printed with draft quality.

*DEVD

The print quality is set on the printer by the user. It is not set in the data stream.

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

Control character (CTLCHAR)

Specifies whether the printer device file supports input with print control characters. Any control characters found that are not valid are ignored, and single spacing is assumed.

*NONE

No print control characters are passed in the data printed.

*FCFC

The first character of every record contains an 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.

Channel values (CHLVAL)

Specifies a list of channel numbers with their assigned line numbers. Use this parameter only if *FCFC is specified in the Control character (CTLCHAR) parameter.

Note: If one or more channel-number/line-number combinations are changed, all other combinations must be re-entered.

Single values

*NORMAL

The default values for skipping to channel identifiers are used.

Element 1: Channel

1-12

Specify an American National Standard channel number to be associated with a corresponding 'skip to' line number. Values for this parameter correspond 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 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

Element 1: Line

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. Each line number should be specified only once.

Fidelity (FIDELITY)

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

*CONTENT

Printing continues when errors are found.

*ABSOLUTE

Printing stops when errors are found.

Character identifier (CHRID)

Specifies the character identifier (graphic character set and code page) for the file. This parameter allows you to print text that is in different character identifier (graphic character set and code page) coding. The value specified on this parameter is used to command the printer device to interpret the hexadecimal byte string by printing the same characters that were intended when the text was created.

Single values

*DEVD

The default CHRID value that the device is designed to handle is used. Character selection is normal because the file has the same character identifier as the device default.

*SYSVAL

The CHRID value specified for the system on which the application runs is used.

*JOBCCSID

The character identifier for the printer file is taken from the coded character set identifier (CCSID) of the job.

Note: This value is not allowed if the file was created on a system at an earlier release level than V2R3M0.

Element 1: Graphic character set

integer

Specify the graphic character set value that matches the printer. Valid values range from 1 through 32767.

Element 2: Code page

integer

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

Decimal format (DECFMT)

Specifies which decimal format value is used when editing numeric fields with the EDTCDE 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.

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

Font character set (FNTCHRSET)

Specifies a downloaded font consisting of a character set and code page. For an outline font, a point size is required. For a raster font, the point size is ignored. This parameter can only be used for printer files with DEVTYPE(*AFPDS) specified.

Single values

*FONT

The value specified on the FONT parameter is used.

Element 1: Character set

Qualifier 1: Character set

name

Specify the name of the font character set.

Element 2: Code page

Qualifier 1: Code page

name

Specify the name of the code page.

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 a point size.

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

*FNTCHRSET

The font specified on the FNTCHRSET parameter is used.

Element 1: Coded font

Qualifier 1: Coded font

name

Specify the coded font name to use.

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.

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/400 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/400. The following print file parameters will be ignored:

• CDEFNT
• CHRID
• CPI
• FNTCHRSET
• FOLD
• FONT
• LPI
• MULTIUP
• PAGESIZE
• PAGRTT
• REDUCE

Single values

*NONE

No page definition is specified.

Because PSF/400 requires a page definition when *LINE or *AFPDSLINE is specified, an inline page definition is built from the print file parameters and passed to PSF/400 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.

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/400. The following print file parameters will be ignored:

• DUPLEX (If *FORMDF specified)
• DRAWER (If *FORMDF specified)
• PAGRTT
• PRTQLTY
• FORMFEED
• FRONTMGN
• BACKMGN
• MULTIUP
• REDUCE
• CORNERSTPL
• EDGESTITCH
• SADLSTITCH

Single values

*NONE

No form definition is used.

Because PSF/400 requires a form definition, an inline form definition is built from the print file parameters and passed to PSF/400 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.

AFP Characters (AFPCHARS)

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

Single values

*NONE

No AFP characters (coded fonts) specified.

Other values (up to 4 repetitions)

name

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.

Table Reference Characters (TBLREFCHR)

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

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

Degree of page rotation (PAGRTT)

Specifies the degree of rotation of the text on the page with respect to the way the form is loaded into the printer.

*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 printed 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.

0

No rotation is done. Printing starts at the edge loaded into the printer first, and is parallel to that edge.

90

Rotation of the text is done 90 degrees clockwise from the 0 degree writing position.

180

Rotation of the text is done 180 degrees clockwise from the 0 degree writing position.

270

Rotation of the text is done 270 degrees clockwise from the 0 degree writing position.

Pages per side (MULTIUP)

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

1

One page of output is printed on one physical sheet of paper.

2

Two pages of output are printed on 1 physical sheet of paper.

3

Three pages of output are printed on 1 physical sheet of paper.

4

Four pages of output are printed on 1 physical sheet of paper.

Reduce output (REDUCE)

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

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

*TEXT

The text output is reduced when doing multiple up printing.

*NONE

The output is not reduced when doing multiple up printing.

Print text (PRTTXT)

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

*JOB

The value from the current job is used.

*BLANK

No text is printed.

character-value

Specify no more that 30 characters of text, enclosed in apostrophes.

Hardware justification (JUSTIFY)

Specifies the printing positions of the characters on a page so that the right-hand margin of printing is regular.

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 (added where the blanks already exist) until the right margin is flush.

Print on both sides (DUPLEX)

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

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

*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 output that will be bound at the top.

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

Unit of measure (UOM)

Specifies the unit of measurement to be used.

*INCH

The inch is used as the unit of measurement.

*CM

The centimeter is used as the unit of measurement.

Front side overlay (FRONTOVL)

Specifies the qualified name of 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

Qualifier 1: Overlay

name

Specify the name of the overlay.

Element 2: Offset down

0

No offset down from the point of origin is used.

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

Element 3: Offset across

0

No offset across from the point of origin is used.

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

Back side overlay (BACKOVL)

Specifies the object name and library name containing 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 that are specified on the FRONTOVL parameter are used.

*NONE

No overlay is used.

Element 1: Overlay

Qualifier 1: Overlay

name

Specify the name of the overlay.

Element 2: Offset down

0

No offset down from the point of origin is used.

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

Element 3: Offset across

0

No offset across from the point of origin is used.

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

Element 4: Constant back

*NOCONSTANT

No constant back is specified.

*CONSTANT

Constant back is specified.

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.

IPDS pass through (IPDSPASTHR)

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

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

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

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

character-value

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/400 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 is ignored.

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.

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

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.

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

*DEVD

The reference edge offset is the default reference edge offset used by the device.

0.0-57.79

Specifies 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.57. This value is converted to millimeters for the printer. Fractional millimeters are not supported and are discarded 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.

*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 the number of staples is specified, 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.

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

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 offset 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.57. This value is converted to millimeters for the printer. Fractional millimeters are not supported and are discarded when when conversion to millimeters is performed.

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

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

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

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

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 offset values are specified, then *DEVD must be specified for the 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.57. This value is converted to millimeters for the printer. Fractional millimeters are not supported and are discarded when when conversion to millimeters is performed.

Font resolution for formatting (RNTRSL)

Specifies the resolution PSF/400 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 Printer Device Programming manual section entitled User and Device Resource Library Lists in the chapter called Working With PSF configuration objects.

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

Defer write (DFRWRT)

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

*YES

The system controls the amount of output that is held in the buffer before it is sent to the printer.

*NO

If *NO is specified on this parameter and if *NO is specified on 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 on this parameter and if *YES is specified on the SPOOL parameter and if *IMMED is specified on 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.

Spool the data (SPOOL)

Specifies whether the output data for the printer device file is spooled.

*YES

The data is spooled for processing by a diskette writer or printer writer.

*NO

The data is not spooled. It is sent directly to the device to print as the output becomes available.

Output queue (OUTQ)

Specifies the output queue used for spooled files that specify OUTQ(*JOB). This parameter applies only to printer files that have *JOB specified for the OUTQ parameter.

Single values

*DEV

The output queue associated with the printer specified on the DEV parameter is used. The output queue has the same name as the printer.

*JOB

The output queue associated with this job is used for the spooled output.

Qualifier 1: Output queue

name

Specify the name of the output queue to which the output data is spooled.

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 library where the output queue is located.

Form type (FORMTYPE)

Specifies the type of forms used in the printer for printed output that is produced using this device file. If a form type other than *STD is specified, the system sends a message that identifies the form type to the system operator when the output is produced, and requests that the specified type of forms be put in the printer. This parameter overrides the form type value specified in the printer file or in other called OVRPRTF commands.

*STD

The standard printer form for your computer system is used.

character-value

Specify a form type identifier, having 10 characters or less, for the printer forms used.

Copies (COPIES)

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

Page range to print (PAGERANGE)

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

Element 1: Starting page

*ENDPAGE

Use the end page value as the starting page.

integer

Specify the starting page to print.

Element 2: Ending page

*END

Printing continues until the end of file.

integer

Specify the ending page to print.

Max spooled output records (MAXRCDS)

Specifies, for spooled output only, the maximum number of records that can be in the spooled file for jobs using the printer file. This parameter overrides the value specified in the printer file or in other called OVRPRTF commands.

*NOMAX

There is no maximum on the number of records that can be in the spooled file.

1-999999

Specify the maximum number of records that can be in the spooled output file.

File separators (FILESEP)

Specifies, for spooled output only, the number of separator pages placed at the beginning of each printed file, including the pages 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 the job number. This parameter overrides the separator value specified in the printer file or in other called OVRPRTF commands.

0-9

Specify the number of separator pages used at the start of each printed output file produced by this device file. 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.

Spooled output schedule (SCHEDULE)

Specifies, for spooled output files only, when the spooled output file is made available to a spooling writer. This parameter overrides the scheduling value specified in the printer file or in other called OVRPRTF commands.

*JOBEND

The spooled output file is available to the spooling writer only after the entire job is completed.

*FILEEND

The spooled output file is available to the spooling writer as soon as 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.

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.

Note: This parameter overrides the hold value specified in the printer file or in other called OVRPRTF commands.

*NO

The spooled output file is not held on the output queue. The spooled output is available to a spooling writer based on the Spooled output schedule (SCHEDULE) parameter value.

*YES

The spooled output file is held until it is released by the Release Spooled File (RLSSPLF) command.

Save spooled file (SAVE)

Specifies, for spooled output only, whether the spooled file is saved after the output is produced. This parameter overrides the save value specified in the printer file or in other called OVRPRTF commands.

*NO

The spooled file data is not kept (saved) on the output queue after it is produced.

*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 is set to 1, and the status of the file is changed from WTR to SAV.

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.

*JOB

The output priority associated with the job that created the spooled file is used.

output-priority

Specify a number ranging from 1 (high) through 9 (low) to indicate the output priority.

User data (USRDTA)

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

*SOURCE

If the file was created by a System/36 procedure, the name of the procedure is assigned. If the file was created by an application program, the name of the program is assigned.

character-value

Specify up to 10 characters of user-specified text.

Spool file owner (SPLFOWN)

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

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

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.

This parameter overrides the user-defined options specified in the printer file or in other called OVRPRTF commands.

Single values

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

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.

This parameter overrides the user-defined data specified in the printer file or in other called OVRPRTF commands.

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

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.

This parameter overrides the user-defined object name specified in the printer file or in other called OVRPRTF commands.

Single values

*NONE

No user-defined object specified.

Element 1: Object

Qualifier 1: Object

name

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

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

Spool file name (SPLFNAME)

Specifies, for spooled output only, the spooled output file name.

*FILE

The name of the printer file is used for the spooled output file name.

name

Specify the name of the spooled output file. A maximum of 10 characters can be used.

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.

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

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.

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:

*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:

*NO

The only double-byte character set (DBCS) attributes of the file are those defined in the DDS.

*YES

DBCS attributes, in addition to those defined in the DDS, include putting the DDS keyword for alternative data type (IGCALTTYP) into effect, and identifying DBCS attributes of fields or messages not identified in the DDS.

DBCS extension characters (IGCEXNCHR)

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

*YES

The system processes extension characters.

*NO

The system does not process extension characters; it prints them as undefined characters.

DBCS character rotation (IGCCHRRTT)

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

*NO

The system does not rotate DBCS data when printing.

*YES

The system rotates DBCS data 90 degrees counterclockwise when printing.

DBCS characters per inch (IGCCPI)

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

*CPI

DBCS density is based on the values specified for the Characters per inch (CPI) parameter. The system prints one double-byte character for every two alphanumeric characters. (*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 (same as IGCCPI(*CONDENSED)).
• For CPI(15), DBCS characters print at 7.5 characters per inch.
• For CPI(18), DBCS characters print at 9 characters per inch.
• For CPI(20), DBCS characters print at 10 characters per inch.

*CONDENSED

Condensed printing, where the system prints 20 double-byte characters every three inches, is used.

5

DBCS density is 5 characters per inch.

6

DBCS density is 6 characters per inch.

10

DBCS density is 10 characters per inch.

DBCS SO/SI spacing (IGCSOSI)

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

*YES

The system prints shift control characters as blanks.

*NO

The system does not print shift control characters. These characters do not occupy a position on printed output.

*RIGHT

The system prints two blanks when printing shift-in characters, but does not print shift-out characters.

DBCS coded font (IGCCDEFNT)

Specifies the coded font that the system uses for double-byte character set (DBCS) printing. This parameter is only used when using printers configured with AFP(*YES).

Single values

*SYSVAL

The DBCS coded font specified in the system value is used.

Element 1: DBCS coded font

Qualifier 1: DBCS coded font

name

Specify the DBCS coded font name to use.

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.

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.

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

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

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

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 default wait time specified in the class description is used as the wait time for the file resources to be allocated.

integer

Specify the number of seconds that the program waits for the file resources to be allocated. Valid values range from 1 through 32767.

Record format level check (LVLCHK)

Specifies whether the level of the device file is checked when the file is opened by a program. For this check, which is done while the file is opened, the system compares the record format identifiers of each record format used by the program with the corresponding identifiers in the device file. Because the same record format name can exist in more than one file, each record format is given a unique internal system identifier when the format is created. Level checking cannot be done unless the program contains the record format identifiers. This command cannot override level checking from *NO to *YES.

*NO

The level identifiers are not checked when the file is opened.

Secure from other overrides (SECURE)

Specifies whether this file is safe from the effects of previously called file override commands.

*NO

This file is not protected from other file overrides. Its values are overridden by the effects of any previously called file override commands.

*YES

This file is protected from the effects of any previously called file override commands.

Override scope (OVRSCOPE)

Specifies the extent of influence (scope) of the override.

*ACTGRPDFN

The scope of the override is determined by the activation group of the program that calls this command. When the activation group is the default activation group, the scope equals the call level of the calling program. When the activation group is not the default activation group, the scope equals the activation group of the calling program.

*CALLLVL

The scope of the override is determined by the current call level. All open operations done at a call level that is the same as or higher than the current call level are influenced by this override.

*JOB

The scope of the override is the job in which the override occurs.

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.

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

Open scope (OPNSCOPE)

Specifies the extent of influence (scope) of the open operation.

*ACTGRPDFN

The scope of the open operation is determined by the activation group of the program that called the OVRPRTF command processing program. If the activation group is the default activation group, the scope is the call level of the caller. If the activation group is a non-default activation group, the scope is the activation group of the caller.

*JOB

The scope of the open operation is the job in which the open operation occurs.

Examples

Example 1: Printing Output

OVRPRTF   FILE(PRINTOUT)  TOFILE(PRINT3)  SPOOL(*YES)
          COPIES(5)  OUTQ(OUTPUT1)

This command overrides the file named PRINTOUT and uses the printer file named PRINT3 to produce the spooled output on the printer. The output from the program is sent to the OUTPUT1 output queue. Five copies of the spooled file are printed on the printer specified on the Start Printer Writer (STRPRTWTR) command.

Example 2: Rotating Double-Byte Characters

OVRPRTF   FILE(IGCPRT)  IGCDTA(*YES)  IGCCHRRTT(*YES)

This command overrides the IGCPRT printer file to make the file DBCS-capable.. The override puts the IGCALTTYP DDS keyword into effect to change character output fields to DBCS fields, and rotates the double-byte characters when printing.

Example 3: Generating Stream File Output

OVRPRTF   FILE(QSYSPRT) DEVTYPE(*AFPDS)
          TOSTMF('/home/user/mypdf.pdf') WSCST(*PDF)

This command overrides the QSYSPRT printer file to generate a stream file "mypdf.pdf" in directory "/home/user". As it is generated, the output stream file will be converted to Portable Document Format (PDF).

Error messages

*ESCAPE Messages

CPF180C

Function &1 not allowed.

CPF7343

Channel number specified more than once on CHLVAL.