Retrieve Printer File Attributes (QDFRPRTA) API


  Required Parameter Group:

1 Receiver variable Output Char(*)
2 Length of receiver variable Input Binary(4)
3 Format of printer file attributes Input Char(8)
4 Qualified printer file name Input Char(20)
5 Error Code I/O Char(*)

  Default Public Authority: *USE

  Threadsafe: Yes

Use the Retrieve Printer File Attributes (QDFRPRTA) API to get specific information about the attributes used to create a printer file.


Authorities and Locks

Library Authority
*EXECUTE
File Authority
*USE
File Lock
*SHRNUP

Required Parameter Group

Receiver variable
OUTPUT; CHAR(*)

The receiver variable that receives the information requested. You can specify the size of the area smaller than the format requested as long as you specify the length of receiver variable parameter correctly. As a result, the API returns only the data the area can hold.

Length of receiver variable
INPUT; BINARY(4)

The length of the receiver variable provided. If the data available is larger than the length of the receiver variable, the result is truncated. The length of receiver variable parameter can be specified up to the size of the receiver variable specified in the user program. If the length of receiver variable parameter specified is larger than the allocated size of the receiver variable specified in the user program, the results are not predictable. The minimum length is 8 bytes.

Format of printer file information
INPUT; CHAR(8)

The format of the printer file information being returned. The format names that can be used are as follows:

PRTF0100 This format returns all the printer file attributes.

See Format PRTF0100 for details.

Qualified printer file name
INPUT; CHAR(20)

The name of the printer file whose attributes are to be extracted and the library in which it is located. The first 10 characters contain the file name. The second 10 characters contain the library name.

You can use these special values for the library name:

*CURLIB The job's current library
*LIBL The job's library list
Error code
I/O; CHAR(*)

The structure in which to return error information. For the format of the structure, see Error code parameter.


Format PRTF0100

The following information is returned when format PRTF0100 is used. For detailed descriptions of the fields in this table, see Field Descriptions.
Offset Type Field
Dec Hex
0 0 Binary(4) Bytes returned
4 4 Binary(4) Bytes available
8 8 Char(10) Printer file name
18 12 Char(10) Printer file library name
28 1C Char(10) Device
38 26 Char(10) Printer device type
48 30 Packed(15,5) Page size length - lines per page
56 38 Packed(15,5) Page size width - positions per line
64 40 Char(10) Page size measurement method
74 4A Char(2) Reserved
76 4C Packed(15,5) Lines per inch
84 54 Packed(15,5) Characters per inch
92 5C Binary(4) Overflow line number
96 60 Char(1) Record format level check
97 61 Char(50) Text description
147 93 Char(1) Reserved
148 94 Packed(15,5) Front margin - offset down
156 9C Packed(15,5) Front margin - offset across
164 A4 Packed(15,5) Back margin - offset down
172 AC Packed(15,5) Back margin - offset across
180 B4 Char(1) Fold records
181 B5 Char(1) Unprintable character action - replace character
182 B6 Char(1) Unprintable character action - replacement character
183 B7 Char(1) Align page
184 B8 Char(10) Control character
194 C2 Char(2) Reserved
196 C4 Binary(4) Offset to channel values list
200 C8 Binary(4) Number of channel values
204 CC Binary(4) Length of channel value entry
208 D0 Char(10) Fidelity
218 DA Char(10) Print quality
228 E4 Char(10) Form feed
238 EE Char(2) Reserved
240 F0 Binary(4) Source drawer
244 F4 Binary(4) Output bin
248 F8 Char(10) Font identifier
258 102 Char(2) Reserved
260 104 Packed(15,5) Font point size
268 10C Binary(4) Character identifier - graphic character set
272 110 Binary(4) Character identifier - code page
276 114 Char(10) Decimal format
286 11E Char(8) Font character set - name
294 126 Char(10) Font character set - library
304 130 Char(8) Font character set - code page
312 138 Char(10) Font character set - code page library
322 142 Char(2) Reserved
324 144 Packed(15,5) Font character set - point size
332 14C Char(10) Coded font - name
342 156 Char(10) Coded font - library
352 160 Packed(15,5) Coded font - point size
360 168 Char(1) Table reference characters
361 169 Char(10) Page definition - name
371 173 Char(10) Page definition - library
381 17D Char(10) Form definition - name
391 187 Char(10) Form definition - library
401 191 Char(3) Reserved
404 194 Binary(4) Offset to AFP™ characters list
408 198 Binary(4) Number of AFP characters
412 19C Binary(4) Length of AFP character
416 1A0 Binary(4) Degree of page rotation
420 1A4 Binary(4) Pages per side
424 1A8 Char(10) Reduce output
434 1B2 Char(30) Print text
464 1D0 Binary(4) Hardware justification
468 1D4 Char(10) Print on both sides
478 1DE Char(1) Defer write
479 1DF Char(10) Unit of measure
489 1E9 Char(8) Front side overlay - name
497 1F1 Char(10) Front side overlay - library
507 1FB Char(1) Reserved
508 1FC Packed(15,5) Front side overlay - offset down
516 204 Packed(15,5) Front side overlay - offset across
524 20C Char(10) Back side overlay - name
534 216 Char(10) Back side overlay - library
544 220 Packed(15,5) Back side overlay - offset down
552 228 Packed(15,5) Back side overlay - offset across
560 230 Char(1) Back side overlay - constant back
561 231 Char(1) Convert line data
562 232 Char(10) IPDS™ pass through
572 23C Binary(4) Offset to user resource library list
576 240 Binary(4) Number of user resource libraries
580 244 Binary(4) Length of user resource library entry
584 248 Char(10) Corner staple
594 252 Char(10) Edge stitch - reference edge
604 25C Packed(15,5) Edge stitch - reference edge offset
612 264 Binary(4) Edge stitch - number of staples
616 268 Binary(4) Edge stitch - offset to staple offsets list
620 26C Binary(4) Edge stitch - number of staple offsets
624 270 Binary(4) Edge stitch - length of staple offset entry
628 274 Char(10) Saddle stitch - reference edge
638 27E Char(2) Reserved
640 280 Binary(4) Saddle stitch - number of staples
644 284 Binary(4) Saddle stitch - offset to staple offsets list
648 288 Binary(4) Saddle stitch - number of staple offsets
652 28C Binary(4) Saddle stitch - length of staple offset entry
656 290 Char(10) Font resolution for formatting
666 29A Char(1) Spool the data
667 29B Char(10) Spooled output queue name
677 2A5 Char(10) Spooled output queue library
687 2AF Char(10) Form type
697 2B9 Char(3) Reserved
700 2BC Binary(4) Copies
704 2C0 Char(7) Expiration date for file
711 2C7 Char(1) Reserved
712 2C8 Binary(4) Days until file expires
716 2CC Binary(4) Page range to print - starting page
720 2D0 Binary(4) Page range to print - ending page
724 2D4 Binary(4) Max spooled output records
728 2D8 Binary(4) File separators
732 2DC Char(10) Spooled output schedule
742 2E6 Char(1) Hold spooled file
743 2E7 Char(1) Save spooled file
744 2E8 Char(1) Output priority
745 2E9 Char(10) User data
755 2F3 Char(10) Spool file owner
765 2FD Char(3) Reserved
768 300 Binary(4) Offset to user defined option list
772 304 Binary(4) Number of user defined options
776 308 Binary(4) Length of user defined option entry
780 30C Char(255) User defined data
1035 40B Char(10) User defined object - name
1045 415 Char(10) User defined object - library
1055 41F Char(10) User defined object - type
1065 429 Char(1) User specified DBCS data
1066 42A Char(1) DBCS extension characters
1067 42B Char(1) DBCS character rotation
1068 42C Char(1) DBCS characters per inch
1069 42D Char(10) DBCS SO/SI spacing
1079 437 Char(8) DBCS coded font - name
1087 43F Char(10) DBCS coded font - library
1097 449 Char(3) Reserved
1100 44C Packed(15,5) DBCS coded font - point size
1108 454 Binary(4) Offset to To Stream File path
1112 458 Binary(4) Length of To Stream File path
1116 45C Char(10) Workstation Customizing Object - name
1126 466 Char(10) Workstation Customizing Object - library
1136 470 Binary(4) Maximum file wait time
1140 474 Char(1) Share open data path
1141 475 Char(3) Reserved
1144 478 Array of Char(*) Channel values list. See Channel value entry definition.
* * Array of Char(*) AFP Characters list
* * Array of Char(*) User resource library list
* * Array of Packed(15,5) Edge stitch - staple offsets
* * Array of Packed(15,5) Saddle stitch - staple offsets
* * Array of Char(*) User defined option list
* * Array of Char(*) To Stream File path


Channel Value Entry

The following table describes the channel value information returned in the PRTF0100 format. For detailed descriptions of the fields in this table, see Field Descriptions.
Offset Type Field
Dec Hex
See note See note Binary(4) Channel number
See note See note Binary(4) Line number for channel
Note: The location and length of the channel value structure may be determined by using the offset to channel values list field and the length of channel value entry field.


Field Descriptions

AFP Characters list. 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.

Align page. Whether the pages must be aligned in the printer before printing is started. The possible values are 0 (*NO) or 1 (*YES).

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

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

Back margin - offset across. Specify the offset of the origin from the left side of the page. The possible values are:

-1 (*FRONTMGN) The offsets specified for the Front margin fields are used.
-2 (*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).
If *CM (centimeter) is specified for the Unit of measure (UOM) field, valid values range from 0 through 57.79 centimeters. If *INCH is specified for the UOM field, valid values range from 0 through 22.75 inches.

Back margin - offset down. Specify the offset of the origin from the top of the page. If *CM (centimeter) is specified for the Unit of measure (UOM) field, valid values range from 0 through 57.79 centimeters. If *INCH is specified for the UOM field, valid values range from 0 through 22.75 inches.

Back side overlay - constant back. 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. The possible values are:

0 No constant back is specified (*NOCONSTANT).
1 Constant back is specified (*CONSTANT).

Back side overlay - library. The name of the library where the overlay is located. The possible values are:

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

Back side overlay - name. The name of 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 possible values are:

*FRONTOVL The values specified for the Front side overlay (FRONTOVL) parameter on the Create Printer File (CRTPRTF) command are used.
*NONE No overlay is used.
name The name of the overlay.

Back side overlay - offset across. The offset across from the point of origin at which to begin printing the overlay . If UOM(*CM) is specified on the Create Printer File (CRTPRTF) command, valid values range from 0 through 57.79 centimeters, and if UOM(*INCH) is specified, valid values range from 0 through 22.75 inches.

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

Back side overlay - offset down. The offset down from the point of origin at which to begin printing the overlay . If UOM(*CM) is specified on the Create Printer File (CRTPRTF) command, valid values range from 0 through 57.79 centimeters, and if UOM(*INCH) is specified, valid values range from 0 through 22.75 inches.

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

Bytes available. The number of bytes of data available to be returned. All available data is returned if enough space is provided.

Bytes returned. The number of bytes of data returned.

Channel number. Specify an American National Standard channel number to be associated with a corresponding 'skip to' line number. The possible values for this field are:

1-12 Range from 1 through 12, corresponding to channels 1 through 12. The channel number is associated with a page line number. For example, if you specified CHLVAL(2 20) on the Create Printer File (CRTPRTF) command, 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.
0 The default values (*NORMAL) 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)

Character identifier - code page. The code page value that matches the printer. Valid values range from 1 through 32767.

Character identifier - graphic character set. The graphic character set for the file. This field and the character identifier code page field allow printing of text that is in different character identifier (graphic character set and code page) coding. The values specified on these fields are 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. The possible values for this field are:

0 The character identifier value specified in the device description of the printer is used (*DEVD).
-1 The character identifier value specified for the system on which the application is running is used (*SYSVAL).
-2 The character identifier for the printer file is taken from the coded character set identifier (CCSID) of the job (*JOBCCSID).

Note: The *JOBCCSID special value, is not allowed if the file was created on a system at an earlier release level than V2R3M0. A file created prior to V2R3M0 will not be tagged with a CCSID and can not be used in combination with the *JOBCCSID support.

-3 The system checks the CHRIDCTL job definition attribute to determine whether to use *JOBCCSID or *DEVD on the CHRID command parameter for this file (*CHRIDCTL).
integer The graphic character set value that matches the printer.

Characters per inch (CPI). Specifies the printer character density, in the unit of measure (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 *CPI is specified for the font identifier field, the font used is based on the CPI value. The following table 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

The possible values are:

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

Coded font - library. The library where the coded font object is located. The possible values are:

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

Coded font - name. The name of the coded font. The possible values are:

*FNTCHRSET The font specified on the Font character set field is used.
name The name of the coded font object.
Note: This field along with the coded font library and coded font point size fields specify the coded font that the system uses for single-byte character set (SBCS) printing. These fields can only be used for printer files with DEVTYPE(*AFPDS) specified.

Coded font - point size. The point size to be used. Range is 0.1-999.9. If 0 (*NONE) is returned, the point size is supplied by the system and is determined by the specified font character set.

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

*NONE No print control characters are passed in the data that is printed.
*FCFC The first character of every record is an American National Standards Institute (ANSI) forms control character. If *FCFC was 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.
Note: If TBLREFCHR(*YES) was specified on the Create Printer File (CRTPRTF) command, then the record length must include two extra positions for the control character and the table reference character.

Convert line data. Whether line data and a page definition should be converted to AFPDS before the data is spooled. The possible values are 0 (*NO) or 1 (*YES).

Copies. For spooled output only, the number of copies of the output being printed. Range from 1 to 255.

Corner staple. 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. The possible values are:

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

Days until file expires. The 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. Range from 1 to 366. If the Expiration date for file field has a value other than *DAYS, 0 is returned for this field.

DBCS character rotation. Whether the printer rotates the double-byte character set (DBCS) characters 90 degrees counterclockwise when printing. The system prints rotated DBCS characters so that they appear in a vertical reading sequence. Alphanumeric characters are not rotated. The possible values are 0 (*NO) or 1 (*YES).

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

Note:This field does not specify the printer character density of alphanumeric characters. Alphanumeric characters are printed with the value specified on the CPI parameter on the Create Printer File (CRTPRTF) command.

The possible values are:

'00'X DBCS character density is based on the values specified for the Characters per inch (CPI) parameter on the CRTPRTF command.
  • For CPI(10), DBCS characters print at 5 characters per inch.
  • For CPI(12), DBCS characters print at 6 characters per inch.
  • For CPI(13.3), DBCS characters print at 6.7 characters per inch.
  • For CPI(15), DBCS characters print at 7.5 characters per inch.
'01'X Condensed printing is used in which the system prints 20 DBCS characters every 3 inches. This value is valid only for the 5553 or 5583 printers.
'05'X DBCS character density is 5 CPI.
'06'X DBCS character density is 6 CPI.
'0A'X DBCS character density is 10 CPI.

DBCS coded font - library. The library where the coded font name is located. The possible values are:

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

DBCS coded font - name. The coded font that the system uses for double-byte character set (DBCS) printing. The possible values are:

*SYSVAL The DBCS coded font specified in the system value QIGCCDEFNT is used.
name The name of the coded font to use.

DBCS coded font - point size. The DBCS coded font point size. If a point size is specified, range from 0.1 to 999.9. If 0 (*NONE) is returned, the point size is supplied by the system and is determined by the specified font character set.

DBCS extension characters. Whether the system processes double-byte character set (DBCS) extension 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. The possible values are 0 (*NO) or 1 (*YES).

DBCS SO/SI spacing. How the system prints shift-in and shift-out characters. The possible values are:

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

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

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

Defer write. Whether output is held in the system buffer before being sent to the printer. The possible values are 0 (*NO) or 1 (*YES).

Degree of page rotation. The degree of text rotation for the 3112, 3116, 3130, 3812, 3816, 4028, 3820, 3825, 3827, 3829, 3831, 3835, 3900, 3916, 3930 and 3935 printers. This value allows the user to specify the degree of rotation of the text on the page with respect to the way the form is loaded into the printer.

0 The operating system sends a device (*DEVD) 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.
-1 Computer output reduction (*COR) is done. Computer output reduction allows output intended for a 13.2 inch wide by 11.0 inch long form to be printed on an 8.5 inch wide by 11.0 inch long form.

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

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

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

  • A top and left margin of 0.5 inches is added to the printed output.
  • The 12-pitch fonts are changed to a 15-pitch font and 15-pitch fonts are changed to a 20-pitch font. All other font widths are changed to a 13.3-pitch font, except for the 4028 printer where they are changed to a 15-pitch font.
  • Vertical spacing (specified by the LPI parameter) is 70 percent of the normal spacing.
  • The page size is set to 8.5 inches wide by 11 inches long.
-2 Indicates that automatic rotation (*AUTO) 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.
90 Text is rotated 90 degrees clockwise from the 0-degree writing position.
180 Text is rotated 180 degrees clockwise from the 0-degree writing position.
270 Text is rotated 270 degrees clockwise from the 0-degree writing position.
360 No rotation is done. Printing starts at the edge loaded into the printer first, and is parallel to that edge.

Device. 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. The possible values are:

*JOB The printer associated with the job is the printer device.
*SYSVAL The printer device named in the system value QPRTDEV is used.
name The name of the printer device used with this printer file.

Edge stitch - length of staple offset entry. The length in bytes of one staple offset entry.

Edge stitch - number of staple offsets. The number of staple offset entries in the staple offsets list.

Edge stitch - number of staples. The number of staples that are to be applied along the finishing operation axis. The possible values are:

-1 (*DEVD ) The number of staples depends on the value of the edge stitch staple offsets field. If *DEVD is also specified or defaulted for the edge stitch staple offsets field, 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 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.

Edge stitch - offset to staple offsets list. The offset to the user staple offsets list.

Edge stitch - reference edge 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. Refer to your printer's documentation for information about which elements of the EDGESTITCH parameter for a printer file 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. The possible values are:

*NONE An edge stitch is not specified.
*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.

Edge stitch - reference edge offset. The offset of the edge stitch from the reference edge. If UOM(*CM) is specified on the Create Printer File (CRTPRTF) command, valid values range from 0 through 57.79 centimeters, and if UOM(*INCH) is specified, valid values range from 0 through 22.75 inches. This value is converted to millimeters for the printer. Fractional millimeters are not supported and are discarded when conversion to millimeters is performed. If -1 (*DEVD) is returned, the reference edge offset is the default reference edge offset used by the device.

Edge stitch - staple offsets. 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. The possible values are:

-1 (*DEVD) The staple offsets are the default staple positions used by the device. If a value was specified for the Number of Staples field, the staple position of each staple will be calculated automatically by the printer. If this value is returned, no additional staple offsets are returned.
0.0-57.79 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 on the Create Printer File (CRTPRTF) command, valid values range from 0 through 57.79 centimeters, and if UOM(*INCH) is specified, valid values range from 0 through 22.75 inches. This value is converted to millimeters for the printer. Fractional millimeters are not supported and are discarded when conversion to millimeters is performed.

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

*NONE No expiration date is specified.
*DAYS The expiration date is to be calculated using the value returned on the Days until file expires field.
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 format (CYYMMDD) is returned as follows:
C Century, where 0 indicates years 19xx and 1 indicates years 20xx.
YY Year
MM Month
DD Day

Fidelity. Whether printing continues when print errors are found for printers configured with AFP(*YES). The possible values are:

*CONTENT Printing continues when errors are found.
*ABSOLUTE Printing stops when errors are found.

File separators. For spooled output files only, the number of separator pages placed at the start of each printed file, including those between multiple copies of the same output. Each separator page has the following items printed on it: file name, file number, job name, user name, and job number. Value range is 0 to 9. 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.

Fold records. Whether all positions in a record are printed when the record length exceeds the page width (returned in the Page size width field). 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 possible values are 0 (*NO) or 1 (*YES).

Note: Fold records is ignored under the following conditions:

Font character set - code page. The name of the code page

Font character set - code page library. The library where the code page object is located. The possible values are:

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

Font character set - library. The library where the font character set is located. Special values are:

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

Font character set - name. The name of the font character set. The possible values are:

*FONT The value specified on the Font identifier field is used.
name The name of the font character set.

Font character set - point size. The point size to be used. Range is 0.1-999.9. If 0 (*NONE) is returned, the point size is supplied by the system and is determined by the specified font character set.

Font identifier. The numeric font identifier to be used with this printer device file. The possible values are:

*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.
identifier Specify the numeric font identifier to be used with this printer device file.

Font point size. The font point size. The possible values are:

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

Font resolution for formatting. 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. The possible values are:

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

Form definition - library. The name of the library to be searched. The possible values are:

*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 The name of the library to be searched.

Form definition - name. 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. The possible values are:

*NONE No form definition is used.

Note: 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.
name The name of the form definition.

When a form definition (*DEVD or form definition name) is specified 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:

Form feed. The form feed attachment used by this printer device file. The possible values are:

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

Form type. The type of forms used in the printer. The possible values are:

*STD The standard printer form for your computer system is used.
character-value The type of printer form used with this device file for printed output.

Front margin - offset across. The offset of the origin from the left side of the page. The possible values are:

-2 (*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).
If *CM (centimeter) is specified for the Unit of measure (UOM) field, valid values range from 0 through 57.79 centimeters. If *INCH is specified for the UOM parameter, valid values range from 0 through 22.75 inches.

Front margin - offset down. The offset of the origin from the top of the page. If *CM (centimeter) is specified for the Unit of measure (UOM) field, valid values range from 0 through 57.79 centimeters. If *INCH is specified for the UOM parameter, valid values range from 0 through 22.75 inches.

Front side overlay - library. The name of the library where the overlay is located. The possible values are:

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

Front side overlay - name. The 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. If *NONE is returned no overlay is used.

Front side overlay - offset across. The offset across from the point of origin at which to begin printing the overlay. If UOM(*CM) is specified on the Create Printer File (CRTPRTF) command, valid values range from 0 through 57.79 centimeters, and if UOM(*INCH) is specified, valid values range from 0 through 22.75 inches.

Front side overlay - offset down. The offset down from the point of origin at which to begin printing the overlay. If UOM(*CM) is specified on the Create Printer File (CRTPRTF) command, valid values range from 0 through 57.79 centimeters, and if UOM(*INCH) is specified, valid values range from 0 through 22.75 inches.

Hardware justification. The printing positions of the characters on a page so that the right-hand margin of printing is regular. Justification is done to the record length on the printer file opened. The possible values are:

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

Note: Hardware justification is supported only on the 3812 SCS, 3816 SCS, and 5219 SCS printers.

Hold spooled file. 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. The possible values are 0 (*NO) or 1 (*YES).

IPDS pass through. Whether IPDS (intelligent printer data stream) pass-through is done for the spooled file. The possible values are:

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

Note: Not all SCS or IPDS spooled files are eligible for IPDS pass-through. They may contain special functions that require transform to AFPDS for correct printing. Specifying IPDS pass-through on the printer file allows only those spooled files eligible for IPDS pass-through to bypass the extra transforms. Those spooled files not eligible for IPDS pass-through will still undergoes the transforms to AFPDS and back to IPDS.

IPDS pass-through will not be valid for all PSF/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.

Length of AFP character. The length of one AFP character.

Length of channel value entry. The length of one channel value entry.

Length of To Stream File path. The length of the To Stream File path string.

Length of user defined option entry. The length of one user defined option entry.

Length of user resource library entry. The length of one user resource library entry.

Line number for channel. The line number assigned for the channel number in the same list. 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.

Lines per inch (LPI). The line spacing setting on the printer, in the unit of measure (lines per inch), used by this device file. The possible values are:

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

Max spooled output records. For spooled output only, the maximum number of records that can be in the spooled file for spooled jobs using this printer file. Value range is 0-999999. If 0 (*NOMAX) is returned, there is no maximum on the number of records that can be in the spooled file.

Maximum file wait time. 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. The possible values are:

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

Number of AFP characters. The number of AFP characters. If 0 is returned, AFPCHARS(*NONE) command parameter is specified.

Number of channel values. The number of times the channel value entries are repeated. These fields are the channel number and channel line number. If 0 is returned, CHLVAL(*NORMAL) command parameter is specified.

Number of user defined options. The number of user defined options. If 0 is returned, USRDFNOPT (*NONE) command parameter is specified.

Number of user resource libraries. The number of user resource libraries. If 0 is returned, USRRSCLIBL (*DEVD) command parameter is specified.

Offset to AFP characters list. The offset to the AFP characters list.

Offset to channel values list. The offset to the channel values list.

Offset to To Stream File path. The offset to the To Stream File path string.

Offset to user defined option list. The offset to the user defined option list.

Offset to user resource library list. The offset to the user resource library list.

Output bin. The destination of the output on printers capable of multiple output bins. The possible values are:

0 (*DEVD) The destination of the output is the device default output bin.
1-65535 Specify the output bin for the destination of the output.

Output priority. The output priority for spooled output files that are produced by this job. The highest priority is 1 and the lowest priority is 9. If 0 (*JOB) is returned, the output priority associated with the job that created the spooled file is used.

Overflow line number. The line number on the page at which overflow to a new page begins. Generally, after the specified line is printed, the printer overflows to the next page before printing continues. Margins specified for the printer file are ignored when determining overflow.

Page definition - library. The page definition library to be searched. The possible values are:

*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 The name of the library to be searched.

Page definition - name. The name of the page definition be used to format line data. Device type *AFPDSLINE, *LINE, or *USERASCII must be specified when using a page definition. If *NONE is returned, no page definition is specified. If a page definition with *LINE, *AFPDSLINE, or *USERASCII data was specified, PSF/400 will convert the line data and page definition to IPDS.

When a page definition on the printer file is specified, some printer file parameters will be ignored when the spooled file is printed by PSF/400. The following print file parameters will be ignored:

Note: Because PSF/400 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/400 when *NONE is specified.

Page range to print - ending page. The ending page number to print. The possible values are:

0 (*END) Printing continues until the end of the spooled file.
integer The ending page number.

Page range to print - starting page. The starting page number to print. The possible values are:

-1 (*ENDPAGE) Use the end page value as the starting page.
integer The starting page number.

Page size length - lines per page. The page length that is used by this printer file. The length is specified in lines per page or by the units specified in the Unit of measure field.

Page size measurement method. The method used to measure the length and width of the page size. The possible values are:

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

Page size width - positions per line. The page width that is used by this printer file. The width is specified in print positions (characters) per line or by the units specified for the Unit of measure field.

Pages per side. Specifies, for spooled output only, whether or not multiple pages of output are printed on 1 physical page. The possible values are:

1 One page of output is printed on each physical page.
2 Two pages of output are printed on each physical page.
3 Three pages of output are printed on each physical page.
4 Four pages of output are printed on each physical page.

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

Print on both sides. Whether output is printed on one side or two sides of the paper. The possible values are:

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

Print quality. The quality of the print produced. The possible values are:

*STD The output is printed with standard quality.
*DEVD The print quality is set on the printer by the user. It is not set in the data stream.
*DRAFT The output is printed with draft quality.
*NLQ The output is printed with near letter quality.
*FASTDRAFT The output is printed at a higher speed and with lower quality than it would be if you specified *DRAFT. This value is only supported by the4230 printer.
Note: For the 4214 printer, only draft (*DRAFT), quality (*NLQ), and device default (*DEVD) modes are supported. Other values are set to quality (*NLQ) mode.

Print text. The text that is printed at the bottom of each page of printed output and on separator pages. The possible values are:

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

Printer device type. The type of data stream that is used for a printer device file. The possible values are:

*SCS An SNA character stream (SCS) is used. This value is valid only 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 used and the spooled printer file is directed to an IPDS printer, the SCS printer file is converted to emulate an IPDS printer file.
*IPDS An intelligent printer data stream (IPDS) is used. This value is valid when using an IPDS printer. If *IPDS is used 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.
*USERASCII An ASCII data stream is placed on a spooled output queue. User is responsible for placing the entire hexadecimal data stream in the buffer, since the operating system does not change or validate the values that are passed.
*AFPDS An Advanced Function Printing™ data stream (AFPDS) is used. Some systems refer to this data stream as MODCA-P.
*AFPDSLINE Mixed data (line data and AFPDS data) is used. This value is valid when using any printer supported by PSF.
*LINE Line data is used. This value is valid when using any printer supported by PSF.

Printer file library name. The name of the library in which the printer file resides.

Printer file name. The name of the printer file about which information is returned.

Record format level check. Whether the level identifiers of the record formats in this device file are checked when the file is opened by a program. The possible values are 0 (*NO) or 1 (*YES)..

Reduce output. Whether or not to reduce the output when doing multiple up printing. The possible values are:

*TEXT The text output is reduced when doing multiple up printing.
*NONE The output is not reduced when doing multiple up printing.

Reserved. The field is reserved.

Saddle stitch - length of staple offset entry. The length in bytes of one staple offset entry.

Saddle stitch - number of staple offsets. The number of staple offset entries in the staple offsets list.

Saddle stitch - number of staples. The number of staples that are to be applied along the finishing operation axis. The possible values are:

-1 (*DEVD ) The number of staples depends on the value of the saddle stitch staple offsets field. If *DEVD is also specified or defaulted for the saddle stitch staple offsets field, 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 The number of staples to be used for the saddle 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.

Saddle stitch - offset to staple offsets list. The offset to the user staple offsets list.

Saddle stitch - reference edge 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. The possible values are:

*NONE A saddle stitch is not specified.
*DEVD The reference saddle is the default reference saddle used by the device.
*TOP The reference saddle is the top saddle of the media.
*LEFT The reference saddle is the left saddle of the media.

Saddle stitch - staple offsets. 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 saddle or the left saddle 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. The possible values are:

-1 (*DEVD) The staple offsets are the default staple positions used by the device. If a value was specified for the Number of Staples field, the staple position of each staple will be calculated automatically by the printer. If this value is returned, no additional staple offsets are returned.
0.0-57.79 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 on the Create Printer File (CRTPRTF) command, valid values range from 0 through 57.79 centimeters, and if UOM(*INCH) is specified, valid values range from 0 through 22.75 inches. This value is converted to millimeters for the printer. Fractional millimeters are not supported and are discarded when conversion to millimeters is performed.

Save spooled file. For spooled output files only, whether the spooled file is saved (kept on the output queue) after the output has been produced. The possible values are 0 (*NO) or 1 (*YES). If 1 is returned, The spooled file data is kept on the output queue until the file is deleted. After the file is produced, the number of copies (see Copies field) is set to 1, and its status is changed from WTR to SAV. Refer to the Release Spooled File (RLSSPLF) command for information on how to produce the spooled file again.

Share open data path. 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. The possible values are:

0 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.
1 The same ODP is shared with each program in the job that also specifies *YES when it opens the file.

Source drawer. The source drawer used when single-cut sheets are semi-automatically fed into the printer. The possible values are:

-3 (*E1) The envelopes are fed from the envelope drawer on the sheet-feed paper handler.
-4 (*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.

Spool file owner. For spooled output only, who the owner of the spooled file is. The possible values are:

*CURUSRPRF The spooled file is owned by the current effective user of the current job or thread.
*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.
*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 manner as *JOB.

Spool the data. Specifies whether the output data for the printer device file is spooled. If SPOOL(*NO) is specified on the Create Printer File (CRTPRTF) command, the following parameters on that command are ignored: OUTQ, COPIES, MAXRCDS, FILESEP, SCHEDULE, HOLD, SAVE, OUTPTY, and USRDTA. The possible values are 0 (*NO) or 1 (*YES).

Spooled output queue library. The library where the output queue is located. The possible values are:

*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, the QGPL library is used.
name The name of the library where the output queue is located.

Spooled output queue name. The name of the output queue (*OUTQ) object. The possible values are:

*JOB The output queue associated with this job is used for the spooled output..
*DEV The output queue associated with the printer specified for the Device field is used. The output queue has the same name as the printer.
name The name of the output queue.

Spooled output schedule. For spooled output files only, when the spooled output file is made available to a diskette writer. Possible values are:

*JOBEND The spooled output file is made available after the job is completed.
*FILEEND The spooled output file is made available when the file is closed in the program.
*IMMED The spooled output file is made available to the writer as soon as the file is opened in the program.

Table Reference Characters. Whether table reference characters are present in the line data. The possible values are 0 (*NO) or 1 (*YES).

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

Text description. The text that describes the printer device file.

To Stream File path. 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 To Stream File 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. The possible values are:

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

Unit of measure. The unit of measurement to be used. The possible values are:

*INCH The inch is used as the unit of measurement.
*CM The centimeter is used as the unit of measurement.

Unprintable character action - replace character. Specifies whether unprintable characters are replaced. The possible values are 0 (*NO) or 1 (*YES).

Note: If DEVTYPE(*IPDS) and RPLUNPRT(*YES) were specified on the Create Printer File (CRTPRTF) command, a hyphen (-) is printed for the unprintable character.

Unprintable character action - replacement character. The replacement character that is used each time an unprintable character is detected. This character is used only if unprintable characters are replaced. Any printable EBCDIC character can be specified (X'40'-X'FE').

User data. For spooled output, user-specified data that identifies the file. The possible values are:

*SOURCE If the spooled file was created by an application program, the name of that program is used. Otherwise, blanks are used.
character-value Up to 10 characters of text.

User defined data. For spooled output only, the user-defined data to be used by user applications or user-specified programs that process spooled files. The possible values are:

*NONE No user-defined data specified.
character-value User-defined data to be used by user applications or user-specified programs that process spooled files. All characters are acceptable.

User defined object - library. The library where the user-defined object is located. The possible values are:

*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 used.
name The name of the library to be searched.

User defined object - name. The user-defined object to be used by user applications or user-specified programs that process spooled files. If no user-defined object is specified, *NONE is returned.

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

User defined option list. 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. The possible values are:

*NONE No user-defined options specified.
character-value User-defined option to be used by user applications or user-specified programs that process spooled files. All characters are acceptable.

User resource library list. 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. The possible values are:

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

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

For program described files the possible values are:

0 (*NO) The file does not process double-byte character set (DBCS) data.
1 (*YES) The file processes double-byte character set (DBCS) data.

For externally described files, the possible values are:

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

Workstation Customizing Object - library. The library where the Workstation customizing object is located. The possible values are:

*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 The name of the library to be searched.

Workstation Customizing Object - name. 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 parameter is not *NONE.

*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.
name Specify the name of the customizing object.


Error Messages

The following messages may be sent from this function:

Message ID Error Message Text
CPF0670 E Object &1 is not a printer file.
CPF0799 E Unable to allocate library &1.
CPF24B4 E Severe error while addressing parameter list.
CPF3CF1 E Error code parameter not valid.
CPF3CF2 E Error(s) occurred during running of &1 API.
CPF3C19 E Error occurred with receiver variable specified.
CPF3C21 E Format name &1 is not valid.
CPF3C24 E Length of the receiver variable is not valid.
CPF9810 E Library &1 not found.
CPF9812 E File &1 in library &2 not found.
CPF9820 E Not authorized to use library &1.
CPF9822 E Not authorized to file &1 in library &2.



API introduced: V6R1

[ Back to top | Database and File APIs | APIs by category ]