Create Printer File (CRTPRTF)

The Create Printer File (CRTPRTF) command creates a printer device file from the information specified on this command and, optionally, from the data description specifications (DDS) contained in a source file.

A printer device file is used to send records to a printer device. The printer device file identifies the printer device used and the spooling requirements; it does not contain data.

Parameters

File (FILE)

Specifies the printer device file to be created.

If the file is used in a high-level language program, the file name should be consistent with the naming rules of that language; otherwise, the file must be renamed in the program itself.

This is a required parameter.

Qualifier 1: File

name

Specify the name of the printer device file.

Qualifier 2: Library

*CURLIB

The current library for the job is used to locate the printer device file. If no library is specified as the current library for the job, QGPL is used.

name

Specify the library where the file is located.

Source file (SRCFILE)

Specifies the source file (if one is specified) containing the data description specifications (DDS) source file used to create the printer device file. More information on the specifications that can be made in DDS is in the Printing category in the IBM i Information Center at http://www.ibm.com/systems/i/infocenter/ and the DDS topic collection in the Programming category in the IBM i Information Center at http://www.ibm.com/systems/i/infocenter/.

Single values

*NONE

There is no DDS source file for this printer device file.

Qualifier 1: Source file

name

Specify the name of the source file that contains the DDS for this printer 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 searched. If no library is specified as the current library for the job, the QGPL library is used.

name

Specify the name of the library to be searched.

Source member (SRCMBR)

Specifies the source file member that contains the data description specifications (DDS) source for the printer file being created.

*FILE

The source file member name is the same as the name specified for the File (FILE) parameter.

name

Specify the name of the member in the source file.

Generation severity level (GENLVL)

Specifies the severity level of data description specifications (DDS) messages that cause file creation to fail. This parameter applies only to messages created while processing DDS source files.

20

If errors occur in the DDS source file processing with a severity level greater than or equal to 20, the file is not created.

0-30

Specify the desired severity level value. If 0 is specified, the file is not created. The value specified must be greater than or equal to the value specified for the Flagging severity level (FLAG) parameter.

Flagging severity level (FLAG)

Specifies the minimum severity level of messages to be listed.

0

All messages are listed.

0-30

Specify a number indicating the minimum severity of messages to be listed. The value specified must be greater than or equal to the value specified for the Generation severity level (GENLVL) parameter.

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.

*JOB

The printer associated with the job is the printer device.

*SYSVAL

The printer device specified by the system value QPRTDEV at the time the job is started is the printer device.

name

Specify the name of the printer device used with the printer file.

Printer device type (DEVTYPE)

Specifies the type of data stream created for the printer device file.

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

When using the 5553 and 5583 DBCS-capable printers, DEVTYPE(*SCS) must be specified. An SNA Character Stream (SCS) data stream is created.

*IPDS

An Intelligent Printer Data Stream (IPDS) is created. This parameter can be specified when using an IPDS printer.

*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 IBM i does not change or validate the values that are passed.

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

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 double-byte character set (DBCS) attributes of the file are specified in the field descriptions.

*YES

DBCS attributes in addition to those specified in the field descriptions include: (1) putting the data description specification (DDS) keyword for alternative data type (IGCALTTYP) into effect, and (2) identifying DBCS attributes of fields, values, or messages.

DBCS extension characters (IGCEXNCHR)

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.

*YES

The system processes DBCS extended characters.

*NO

The system does not process DBCS extended characters; it prints extended characters as the undefined character.

Text 'description' (TEXT)

Specifies the text that briefly describes the object.

*SRCMBRTXT

If the source file is a database file, the text is taken from the source file member used to create the file. If the source file is an inline file or a device file, the text is blank.

*BLANK

No text is specified.

character-value

Specify no more than 50 characters of text, enclosed in apostrophes.

Source listing options (OPTION)

Specifies the type of output produced when the file is created. A maximum of four of the following values can be specified in any order on this parameter. If neither or both of the values on an option are specified, the first value listed for the option is used.

Note: The first values on each option are similar to, but are not actually default values, and therefore, cannot be changed with the CHGCMDDFT (Change Command Default) command.

Source Listing Option

*SRC or *SOURCE

A printout of the source statements, including a list of errors, is created.

*NOSRC or *NOSOURCE

No printout of the source statements is created unless errors are detected. If errors are detected, they are listed along with the keyword or record format that caused the error.

Program Listing Option

*LIST

An expanded source printout is created, showing a detailed list of the file specifications and the references to other file descriptions.

*NOLIST

The expanded source printout is not created.

Second-Level Message Text Option

*NOSECLVL

The messages section of the data description specifications (DDS) printout does not contain the online help information for messages issued during DDS processing.

*SECLVL

The online help information appears in the DDS printout.

Event File Creation Option

*NOEVENTF

The compiler does not produce an event file for the CoOperative Development Environment (CODE) product.

*EVENTF

The compiler produces an event file that can be used by the CODE product. The event file is created as a member in the file EVFEVENT in your object library. The CODE product uses this file to offer error feedback integrated with the CODE editor. This value is normally specified by the CODE product on your behalf.

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

66

The page length is 66 print lines per page.

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

132

The page width is 132 printed characters per line.

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

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

Lines per inch (LPI)

Specifies the line spacing setting on the printer, in lines per inch, to be 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.

6

The line spacing on the printer is 6 lines per inch.

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.

Characters per inch (CPI)

Specifies the printer character density, in characters per inch.

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

10

Character density is 10 characters per inch.

5

Character density is 5 characters per inch.

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.

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

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

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

Overflow line number (OVRFLW)

Specifies the line number on the page at which printer overflow to a new page occurs. Overflow is signaled when the specified line number becomes the current line, whether or not printing has occurred on that line.

60

After line 60 has been reached or printed, the printer overflows to a new page.

1-255

Specify the overflow line number. The value specified must not exceed the page length specified in the Page size (PAGESIZE) parameter. 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 is greater than the page width. If *IPDS is specified on the Printer device type (DEVTYPE) parameter, this parameter is ignored.

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:

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

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.

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

*YES

Records whose length is greater than the page width are folded on the following lines.

Unprintable character action (RPLUNPRT)

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

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:

• If IGCEXNCHR(*YES) is also specified, the system replaces unprintable extension characters with DBCS underline characters. There may be some cases in which the system is unable to replace an unprintable character with a DBCS underline character. In this case, the undefined character is printed.
• If IGCEXNCHR(*NO) is also specified, the device replaces all extension characters with the undefined character. Choosing a blank as the replacement character for alphanumeric characters might improve system performance.

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

*YES

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

Element 2: Replacement character

*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. Valid values range from 40 through 99 and A1 through FE.

Align page (ALIGN)

Specifies whether each page 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 CRTPRTF command and ALIGN(*FILE) is specified on the STRPRTWTR command, then 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.

*NO

Page alignment is not required.

*YES

Page alignment is required before the output is printed.

Control character (CTLCHAR)

Specifies whether the printer device file supports input with print control characters.

*NONE

No print control characters are passed in the printed data.

*FCFC

The first character of every record contains 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, which is passed in the printed data.

*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 for the Control character (CTLCHAR) parameter.

Single values

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

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.

Print quality (PRTQLTY)

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

Some non-impact IPDS printers support a toner miser feature. This feature is device dependent. Specifying *DRAFT for the PRTQLTY value will activate the toner miser feature on those printers that support it.

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

More information about the valid values for the 4214, 4224, 4230, 4234, and 5219 Printers is in the Printer Device Programming Manual.

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.

Form feed (FORMFEED)

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

*DEVD

The forms are fed into the printer as specified in the printer device description.

*CONT

Continuous forms are used by the printer. The tractor feed attachment must be on the printer 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 on the printer device.

Source drawer (DRAWER)

Specifies the source drawer used when cut sheets are fed into the printer (specified by FORMFEED(*AUTOCUT)).

1

The paper is fed from the first drawer on the sheet-feed paper handler.

*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 identifier (FONT)

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

More information about the valid font identifiers, the display value, the characters per inch value implied with each font style, a description of each font style, and whether the font is supported on a particular printer is in the Printer Device Programming Manual..

Note: Some fonts can be substituted by the printer. Consult the various printer reference guides for details.

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

Character identifier (CHRID)

Specifies the character identifier (graphic character set and code page) for the printer file. This parameter allows you to print text that has different character identifier coding. The value specified for 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/.

Single values

*DEVD

The default value from the Character identifier (CHRID) parameter that the device is designed to handle is used. The *DEVD value means character selection is normal because the file has the same character identifier as the printer device default.

*SYSVAL

The value on the Character identifier (CHRID) parameter 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: 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 for 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 cannot 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.

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.

*JOB

Use the decimal format value from the DECFMT job attribute when the file is opened.

*FILE

Use the decimal format value stored with the file when the file was created.

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

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

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 the point size to be used.

Note: The point size parameter is only used when an outlined font is named, in other cases it is ignored.

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

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.

Note: The point size parameter is only used when an outlined font is named, in other cases it is ignored.

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.

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

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

Single values

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

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:

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

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)

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.

Degree of page rotation (PAGRTT)

Specifies the degree of rotation of the text on the page with respect to the way the page 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.

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

*COR

Computer output reduction (COR) is used. COR allows printed output intended for a 13.2 inch wide by 11.0 inch long page to be printed on an 11.0 inch wide by 8.5 in long 8.5 inch wide by 11.0 inch long page.

For computer output reduction printing, the following operations are done for cut-sheet IPDS 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 non-impact continuous form printers, 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.

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

0

No rotation is done.

90

The text is rotated 90 degrees clockwise.

180

The text is rotated 180 degrees clockwise.

270

The text is rotated 270 degrees clockwise.

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

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

*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 than 30 characters of text, enclosed in apostrophes.

Hardware justification (JUSTIFY)

Specifies the printing positions of the characters on a page to control the degree of print alignment at the right-hand margin. 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 Printers.

0

No justification occurs.

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. This is usually done for output that is bound at the side.

*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 done for output that is 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 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.75.

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

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

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

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

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 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 to a system using the Distributed Print Function provided by either InfoPrint Manager or Print Services Facility for OS/2.

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)

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

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.

*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

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

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.

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

Single values

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

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

Spool the data (SPOOL)

Specifies whether the output data for the printer device file is spooled. If *NO is specified, the other parameters on this command related to spooling are ignored. This parameter is ignored when the To stream file (TOSTMF) parameter is not *NONE.

*YES

The data is spooled.

*NO

The data is not spooled. It is sent to the printer device and printed as the output becomes available.

Spooled output queue (OUTQ)

Specifies, for spooled output files only, the name of the output queue for the printer file.

Single values

*JOB

The output queue specified in the job description is used.

*DEV

The output queue associated with the printer specified for the 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 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 job library list 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 form on which the output is printed. The identifiers used to indicate the type of forms are user-defined and can be a maximum of 10 characters in length.

*STD

The standard printer form for your computer system is used.

character-value

Specify the identifier of the form type used with this printer device file for printed output.

Copies (COPIES)

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

1

Only one copy of the output is printed.

1-255

Specify the number of copies to print.

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.

Page range to print (PAGERANGE)

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

Element 1: Starting page

1

Printing begins at page 1.

*ENDPAGE

Use the end page value as the starting page.

integer

Specify the starting page number.

Element 2: Ending page

*END

Printing continues until the end of the spooled file.

integer

Specify the ending page number.

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 this printer file. If this maximum is reached, an inquiry message is sent to the program message queue.

100000

A maximum of 100000 records can be contained in the spooled output file for each job that uses this printer device file.

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

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.

0

No separator pages are used.

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.

Spooled output schedule (SCHEDULE)

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

*FILEEND

The spooled output file is available to the writer as soon as the file is closed.

*JOBEND

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

*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 only, whether the spooled file is held. The spooled file can be released by using the Release Spooled File (RLSSPLF) command.

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

Save spooled file (SAVE)

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

*NO

The spooled file data is not saved on the output queue.

*YES

The spooled file data is saved on the output queue until the spooled file is deleted.

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.

1-9

Specify a number ranging from 1 (high) through 9 (low).

User data (USRDTA)

Specifies, for spooled files only, some user-specified data that identifies the file.

*SOURCE

If the spooled file was created by an application program, the name of the program is used. Otherwise, blanks are used.

character-value

Specify no more than 10 characters of text, enclosed in apostrophes.

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.

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.

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

Single values

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

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

DBCS character rotation (IGCCHRRTT)

Specifies whether the printer rotates 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.

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

DBCS characters per inch (IGCCPI)

Specifies the printer character density of double-byte character set (DBCS) characters, 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 for the CPI parameter.

*CPI

DBCS character 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.

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

5

DBCS character density is 5 characters per inch.

6

DBCS character density is 6 characters per inch.

10

DBCS character density is 10 characters per inch.

*CONDENSED

Condensed printing, in which the system prints 20 DBCS characters every 3 inches, is used. This value is valid for the 5553 or 5583 printers only.

DBCS SO/SI spacing (IGCSOSI)

Specifies how the system prints shift control 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 the printer output.

*RIGHT

The system prints two blanks when printing shift-in characters, but it 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.

Single values

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

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.

Note: The point size parameter is only used when an outlined font is named, in other cases it is ignored.

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

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.

Record format level check (LVLCHK)

Specifies whether the level identifiers of the record formats in the printer device file are checked when the file is opened by a program. If so, the record format identifiers in the program must match those in the device file. Because the same record format name can exist in more than one file, each record format is given an internal system identifier when it is created.

*YES

The level identifiers of the record formats are checked. If the level identifiers do not all match, an open error message is sent to the program requesting the open operation.

*NO

The level identifiers of the record formats are not checked.

Authority (AUT)

Specifies the authority you are giving to users who do not have specific authority for the object, who are not on an authorization list, and whose group profile or supplemental group profiles do not have specific authority for the object.

*LIBCRTAUT

The system determines the authority for the object by using the value specified for the Create authority (CRTAUT) parameter on the Create Library command (CRTLIB) for the library containing the object to be created. If the value specified for the CRTAUT parameter is changed, the new value will not affect any existing objects.

*CHANGE

The user can perform all operations on the object except those limited to the owner or controlled by object existence (*OBJEXIST) and object management (*OBJMGT) authorities. The user can change and perform basic functions on the object. *CHANGE authority provides object operational (*OBJOPR) authority and all data authority. If the object is an authorization list, the user cannot add, change, or remove users.

*ALL

The user can perform all operations except those limited to the owner or controlled by authorization list management (*AUTLMGT) authority. The user can control the object's existence, specify the security for the object, change the object, and perform basic functions on the object. The user also can change ownership of the object.

*USE

The user can perform basic operations on the object, such as running a program or reading a file. The user cannot change the object. Use (*USE) authority provides object operational (*OBJOPR), read (*READ), and execute (*EXECUTE) authorities.

*EXCLUDE

The user cannot access the object.

name

Specify the name of an authorization list to be used for authority to the object. Users included in the authorization list are granted authority to the object as specified in the list. The authorization list must exist when the object is created.

Replace file (REPLACE)

Specifies whether an existing file, other than a save or database file, is replaced.

Note: The authority value for the file is determined by the user profile of the user. If an existing file is replaced, the authority value for the new file is copied from the replaced file.

*YES

An existing file with the same name and library is replaced if the creation of the new printer device file is successful.

*NO

The creation of a new printer device file is not allowed if there is an existing file with the same name and library.

Examples

Example 1: Creating a Printer File

CRTPRTF   FILE(DSPHIST)  SRCFILE(PRSNNL/JOBHIST)  FILESEP(3)

This command creates a printer file named DSPHIST using the DDS source file named JOBHIST that is stored in the PRSNNL library. The defaults for the other parameters are assumed, except for FILESEP.

The printer uses standard forms that are 66 lines long and 132 print positions wide. An SCS data stream is used. It prints 6 lines per inch and overflows to a new page after line 60 is printed. The print image specified in the device description is used. Output is spooled to the output queue specified for the job and cannot be printed until the file is closed. The spooled file is not held or saved after printing. One copy of the output is printed, preceded by three separator pages, each containing the file name, the spooled number, and the job name and number. The print text specified in the current job is used.

Example 2: Creating a Printer File Containing DBCS Data

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

This command creates a printer file, IGCPRT (stored in library IGCLIB) that contains DBCS data. Cut sheets are automatically fed, and double-byte characters are rotated when printing.

Example 3: Creating a Printer File to Generate a Stream File.

CRTPRTF FILE(QGPL/MYFAXPRT) TOSTMF('.') WSCST(QWPTIFFPB)
        DEVTYPE(*AFPDS)

This command creates a printer file, MYFAXPRT (stored in library QGPL) that will generate a stream file containing TIFF image format (with packbit compression) in the current working directory. The operating system will generate a random name for the stream file beginning with the printer file name MYFAXPRT.

Error messages

*ESCAPE Messages

CPF339F

Expiration date must be today or a date in the future.

CPF7302

File &1 not created in library &2.