| 1 | Receiver variable | Output | Char(*) |
| 2 | Length of receiver variable | Input | Binary(4) |
| 3 | Format name | Input | Char(8) |
| 4 | Qualified AFP™ object name | Input | Char(20) |
| 5 | Format qualifier | Input | Char(10) |
| 6 | Error code | I/O | Char(*) |
The Retrieve AFP Information (QPQRAFPI) API returns specific information about a PSF configuration object, a font table, or a coded font. The size of the receiver variable determines the amount of information returned.
The receiver variable that receives the information requested. You can specify the size of the area to be smaller than the format requested as long as you specify the length parameter correctly. As a result, the API returns only the data the area can hold.
The length of the receiver variable provided. The length of the receiver variable parameter may be specified up to the size of the receiver variable specified in the user program. If the length of the 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.
The format of the information to be returned for the specified object. The valid format names are:
| PSFI0100 | Information about the specified PSF Configuration Object. |
| CFNI0100 | Information about the specified coded font. |
| FCSI0100 | Information about the specified font character set. |
| FTBI0100 | Information about the specified font table. |
| PHCS0100 | Information about the specified font table. |
| HPCS0100 | Information about the specified font table. |
| PHCP0100 | Information about the specified font table. |
| HPCP0100 | Information about the specified font table. |
| PPCS0100 | Information about the specified font table. |
The AFP object for which you would like to retrieve information. The qualified object name has two parts. The first 10 characters contain the object name.
You may not use special values for the object name when the format name is PSFI0100, CNFI0100, FTBI0100 or PPCS0100.
You must use the following special value for the object name when the format name is FCSI0100:
| *FNTCHRSET | All coded fonts that contain the font character set specified by the font character set parameter are returned. |
You may use one of the following special values for the object name when the format name is FTBI0100:
| *PHFCS | Information about the printer-resident to host-resident font character set table is to be returned. |
| *SYSPHFCS | Information about the system printer-resident to host-resident font character set table is to be returned. |
| *HPFCS | Information about the host-resident to printer-resident font character set table is to be returned. |
| *SYSHPFCS | Information about the system host-resident to printer-resident font character set table is to be returned. |
| *PHCP | Information about the printer-resident to host-resident code page mapping table is to be returned. |
| *SYSPHCP | Information about the system printer-resident to host-resident code page mapping table is to be returned. |
| *HPCP | Information about the host-resident to printer-resident code page mapping table is to be returned. |
| *SYSHPCP | Information about the system host-resident to printer-resident code page mapping table is to be returned. |
You may use one of the following special values for the object name when the format name is PHCS0100:
| *PHFCS | The printer-resident to host-resident font character set table is to be returned. |
| *SYSPHFCS | The system printer-resident to host-resident font character set table is to be returned. |
You may use one of the following special values for the object name when the format name is HPCS0100:
| *HPFCS | The host-resident to printer-resident font character set table is to be returned. |
| *SYSHPFCS | The system host-resident to printer-resident font character set table is to be returned. |
You may use one of the following special values for the object name when the format name is PHCP0100:
| *PHCP | The printer-resident to host-resident code page mapping table is to be returned. |
| *SYSPHCP | The system printer-resident to host-resident code page mapping table is to be returned. |
You may use one of the following special values for the object name when the format name is HPCP0100:
| *HPCP | The host-resident to printer-resident code page mapping table is to be returned. |
| *SYSHPCP | The system host-resident to printer-resident code page mapping table is to be returned. |
You must leave the second 10 characters blank when you use a special value for the AFP object name when the format name is PHCS0100, HPCS0100, PHCP0100, or HPCP0100.
The second 10 characters contain the name of the library where the object is located when the format name is PSFI0100, CFNI0100, FTBI0100, PHCS0100, HPCS0100, PHCP0100, HPCP0100, or PPCS0100.
The following special values are allowed when the format name is PSFI0100, CFNI0100, FTBI0100, PHCS0100, HPCS0100, PHCP0100, HPCP0100, or PPCS0100:
| *CURLIB | The job's current library is used to locate the object. If no library is specified as the current library for the job, the QGPL library is used. |
| *LIBL | The library list is used to locate the object. |
The actual library that is used is returned with the object information.
The second 10 characters contain the name of the library searched for coded fonts that contain the font character set specified in the first 10 characters of the format qualifier when the format name is FCSI0100.
The following special values are allowed when the format name is FCSI0100:
| *CURLIB | Only the libraries in the current library for the job are searched. If no library is specified as the current library for the job, QGPL is used. |
| *LIBL | All libraries in the job's library list are searched. |
| *USRLIBL | Only the libraries listed in the user portion of the job's library list are searched. |
| *ALL | All libraries in the system, including QSYS, are searched. |
| *ALLUSR | All user libraries are searched. For information on the libraries included, see *ALLUSR in Generic library names. |
| *DBCSFNTLIB | The DBCS font libraries QFNT61, QFNT62, QFNT63, QFNT64, and QFNT65 will be searched. |
The font character set name to search for in the coded font objects when the format name is FCSI0100 and the AFP object name is *FNTCHRSET. All coded fonts that contain the font character set specified by the format qualifier parameter are returned.
This parameter must be blank if the format name is not FCSI0100.
The structure in which to return error information. For the format of the structure, see Error code parameter.
The following table shows the information returned for the PSFI0100 format.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Bytes returned |
| 4 | 4 | BINARY(4) | Bytes available |
| 8 | 8 | CHAR(10) | PSF configuration object name |
| 18 | 12 | CHAR(10) | PSF configuration object library name |
| 28 | 1C | CHAR(2) | Reserved |
| 30 | 1E | CHAR(10) | User resource library |
| 40 | 28 | BINARY(4) | Offset to device resource library list entries |
| 44 | 2C | BINARY(4) | Number of device resource library list entries |
| 48 | 30 | CHAR(10) | IPDS™ pass through |
| 58 | 3A | CHAR(10) | Activate release timer |
| 68 | 44 | BINARY(4) | Release timer |
| 72 | 48 | BINARY(4) | Restart timer |
| 76 | 4C | BINARY(4) | APPC and TCP/IP retry count |
| 80 | 50 | BINARY(4) | Delay between APPC retries |
| 84 | 54 | CHAR(10) | Automatic session recovery |
| 94 | 5E | CHAR(10) | Automatic session recovery message option |
| 104 | 68 | BINARY(4) | Acknowledgment frequency |
| 108 | 6C | CHAR(10) | Blank page |
| 118 | 76 | CHAR(10) | Page size control |
| 128 | 80 | CHAR(10) | Resident fonts |
| 138 | 8A | CHAR(10) | Resource retention |
| 148 | 94 | CHAR(10) | Edge orient |
| 158 | 9E | CHAR(10) | Use outline fonts |
| 168 | A8 | BINARY(4) | Offset to PSF-defined options |
| 172 | AC | BINARY(4) | Number of PSF-defined options |
| 176 | B0 | CHAR(10) | Font substitution messages |
| 186 | BA | CHAR(10) | Capture host fonts at printer |
| 196 | C4 | CHAR(10) | Font resolution for formatting |
| 206 | CE | CHAR(10) | Font mapping table name |
| 216 | D8 | CHAR(10) | Font mapping table library |
| 226 | E2 | CHAR(10) | Cut sheet emulation mode |
| 236 | EC | CHAR(10) | Use DBCS simulation fonts |
| 246 | F6 | CHAR(2) | Reserved |
| 248 | F8 | BINARY(4) | Printer response timer |
| 252 | FC | CHAR(10) | Generate PDF output |
| 262 | 106 | CHAR(10) | Device emulation type |
| 272 | 110 | CHAR(10) | Paper size for drawer 1 |
| 282 | 11A | CHAR(10) | Paper size for drawer 2 |
| 292 | 124 | CHAR(10) | Multiple PDF files |
| 302 | 12E | CHAR(10) | Data queue |
| 312 | 138 | CHAR(10) | Data queue library |
| 322 | 142 | CHAR(10) | Sender of electronic mail |
| 332 | 14C | CHAR(10) | Mapping program |
| 342 | 156 | CHAR(10) | Mapping program library |
| 352 | 160 | CHAR(10) | Output queue |
| 362 | 16A | CHAR(10) | Output queue library |
| 372 | 174 | CHAR(256) | Directory |
| 628 | 274 | BINARY(4) | Directory CCSID |
| 632 | 278 | CHAR(50) | Text |
| 682 | 2AA | CHAR(10) | Multiple PDF files process option |
| 692 | 2B4 | CHAR(10) | PDF fonts inline |
| 702 | 2BE | CHAR(2) | Reserved |
| 704 | 2C0 | BINARY(4) | Offset to mail server names |
| 708 | 2C4 | BINARY(4) | Number of mail servers |
| 2C8 | CHAR(10) | Mapping object name | |
| 722 | 2D2 | CHAR(10) | Mapping object library |
| 732 | 2DC | CHAR(80) | PDF administrator |
| 812 | 32C | BINARY(4) | Offset to additional generate PDF output options |
| 816 | 330 | BINARY(4) | Number of additional generate PDF output options |
| 820 | 334 | CHAR(10) | Save AFP Data |
| 830 | 33E | CHAR(10) | AFP Output Queue name |
| 840 | 348 | CHAR(10) | AFP Output Queue library |
| CHAR(*) | Device resource library list entries (ARRAY of CHAR(10)) | ||
| CHAR(*) | PSF-defined option (ARRAY of CHAR(30)) | ||
| CHAR(*) | Mail server names. (ARRAY of CHAR(255)) | ||
| CHAR(*) | Additional generate PDF output options (ARRAY of CHAR(10)) | ||
Acknowledgment frequency. The frequency, in pages, with which PSF/400 sends IPDS acknowledgment requests to a printer. Possible values are 1 to 32767.
The possible values are:
| *NORDYF | The release timer is to be activated when there are no spooled files in the printer's output queue with a status of RDY and the last page of the last spooled file processed has printed. |
| *IMMED | The release timer is to be activated immediately after PSF has successfully linked to the printer. |
| *PRTNORDYF | The release timer is to be activated:
|
| *PRTIMMED | The release timer is to be activated immediately after the writer receives an indication from the printer to release the IPDS dialog. |
Additional generate PDF output options (ARRAY of CHAR(10)) If the user would like the spooled file converted to PDF using the IPDS to PDF transform and more than one option used to distribute the associated PDF output.
Possible values are:
| *NONE | No PDF generation of the spooled file should be performed |
| PDF output will be generated and mailed electronically. | |
| *STMF | PDF output will be generated and placed into a stream file in the directory identified in the directory field. |
| *SPLF | PDF output will be generated and placed on the output queue identified in the output queue field. |
AFP output queue library. The name of the library which contains the default output queue where AFP data will be spooled.
Possible values are:
| Output-queue-library | Name of output queue library. |
AFP output queue name. The name of the default output queue where AFP data will be spooled.
Possible values are:
| Output-queue-name | Name of output queue |
APPC and TCP/IP retry count. The number of times to retry a session start request when attempting to establish a session with a printer.
The possible values are:
| 1 to 99 | The number of retries. |
| -1 | No limit is put on the number of retries. (*NOMAX) |
Automatic session recovery. Whether PSF/400 will automatically attempt to resume printing when a session has been ended unexpectedly by a device.
The possible values are:
| *NO | PSF/400 ends when a session has been unexpectedly ended by a device. |
| *YES | Automatic session recovery is enabled. PSF/400 attempts to reestablish a session that has been ended unexpectedly by a device. |
Automatic session recovery message option. Whether an informational message or an inquiry message is sent to the message queue associated with the writer when PSF/400 is performing automatic session recovery. This field is filled in when automatic session recovery is *YES; otherwise, it is set to blanks.
The possible values are:
| *INFO | An informational message is sent to the message queue associated with the writer when PSF/400 is performing automatic session recovery. |
| *INQ | An inquiry message is sent to the message queue associated with the writer when PSF/400 is performing automatic session recovery. |
Blank page. Whether PSF/400 issues a blank page after every
separator page and spooled file copy that contains an odd number of pages.
The possible values are:
| *YES | PSF/400 issues a blank page after every separator page and spooled file copy that contains an odd number of pages. |
| *NO | PSF/400 does not issue a blank page after every separator page and spooled file copy that contains an odd number of pages. |
Bytes available. The length of all data available to return. All available data is returned if enough space is provided.
Bytes returned. The length of the data actually returned.
Capture host fonts at printer. Whether the printer should capture host downloaded fonts.
The possible values are:
| *NO | The printer should not capture host fonts. |
| *YES | The printer should capture host fonts. |
Cut sheet emulation mode. The degree to which PSF/400 will do size checking of the document when using Cut Sheet Emulation.
The possible values are:
| *NONE | No checking will be done to verify that the document page will fit on half the continuous forms physical page. |
| *CHKFIRST | The first page of each copy group will be checked to determine if the page will fit on half the continuous forms page. |
| *CHKALL | The front side page will be checked to determine if the page will fit on half the continuous forms page. |
Data queue. The name of the data queue where PSF will log the IPDS to PDF transform completion notifications. This field is used only when the generate PDF output field has a value other than *NONE; otherwise it is set to blanks.
Possible values are:
| *NONE | No data queue should be used to log completions. |
| PDF-data-queue | The name of the data queue used for logging transformation completions. |
Data queue library. The name of the library in which the data queue is located. This field is used only when the generate PDF output field has a value other than *NONE; otherwise, it is set to blanks.
Delay between APPC retries. The number, between 0 and 999, of seconds PSF/400 pauses after it receives notification that a session start request has failed.
Device emulation type. The type of device that the IPDS to PDF transform virtual printer device should emulate. This field is used only when the generate PDF output field has a value other than *NONE; otherwise it is set to blanks.
Possible values are:
| *IP40240 | The virtual printer device should emulate an IP40 printer device configured at 240 pels per inch resolution. |
| *IP40300 | The virtual printer device should emulate an IP40 printer device configured at 300 pels per inch resolution. |
| *4028 | The virtual printer device should emulate a 4028 printer device. |
| *3812 | The virtual printer device should emulate a 3812 printer device. |
Device resource library list entry. A device resource library to be used for searching AFP resources.
The following special value may be returned:
| *DFT | The following libraries, if present on the
system, are used in searching for AFP resources.
|
Directory. The directory in which the PDF files will be stored. This field is used only when the generate PDF output field has a value of *STMF; otherwise, it is set to blanks.
Directory CCSID. The CCSID (coded character set ID) of the directory.
The possible values are:
| 0 | There is no directory. |
| 1 to 65533 | The CCSID of the directory |
Edge orient. Whether PSF/400 will rotate the output 270 degress instead of 90 degrees when the page rotation value of a spooled file is *COR or *AUTO.
The possible values are:
| *NO | The output remains at its original orientation. |
| *YES | *COR and *AUTO output of 90 degrees is rotated an additional 180 degrees before printing. |
Font mapping table name. The name of a printer-resident to printer-resident font table.
The following special value may be returned:
| *NONE | No printer-resident to printer-resident font table is specified. |
Font mapping table library. The library in which the printer-resident to printer-resident font table resides.
Font resolution for formatting. The resolution PSF/400 should use to print the spooled file when:
The possible values are:
| *SEARCH | Search the library list for the first occurrence of a host font with a name match. |
| 240 | The font resolution used to print the spooled file should be 240 pels per inch. |
| 300 | The font resolution used to print the spooled file should be 300 pels per inch. |
Font substitution messages. Whether PSF/400 will issue messages indicating that a successful font substitution was performed.
The possible values are:
| *YES | Messages indicating that a successful font substitution was performed are issued. |
| *NO | Messages indicating that a successful font substitution was performed are not issued. |
Generate PDF output. Whether the user would like the spooled file converted to PDF using the IPDS to PDF transform and if so, what to do with the associated PDF output.
Possible values are:
| *NONE | No PDF generation of the spooled file should be performed |
| PDF output will be generated and mailed electronically. | |
| *STMF | PDF output will be generated and placed into a stream file in the directory identified in the directory field. |
| *SPLF | PDF output will be generated and placed on the output queue identified in the output queue field. |
IPDS pass through. Whether IPDS pass-through is done for the device.
The possible values are:
| *NO | No IPDS pass-through is done. |
| *YES | IPDS pass-through is to be done for the device for all spooled files that are eligible for IPDS pass-through. |
Mail server names. The mail server names to use for electronically mailing the
resulting PDF file from the IPDS to PDF transform.>
Mapping object library. Name of the PDF mapping object library, if one was specified on the PSFCFG object. This is set to blanks (X'40') if no value was provided on the PDFMAPBOBJ parameter of the PSFCFG object.
Mapping object name. Name of the PDF mapping object, if one was specified on the PSFCFG object. This is set to blanks (X'40') if no value was provided on the PDFMAPBOBJ parameter of the PSFCFG object.
Mapping program. The name of a user-defined mapping program. The mapping program will receive as input the spool file attributes and mail tag information(if specified in spool file). It will return as output the action to be taken (e-mail, store PDF file in Integrated File System (IFS), or respool PDF to specified output queiue). It will also return any information needed for the specified action, such as one or more mail addresses to use for electronic mailing of the PDF output when e-mail is specified for the action. If this field is blank, then the action specified in the PSF configuration object will be used.
Possible values are:
| *NONE | No mapping program is specified. |
| *IBMPGM | Use the IBM® mapping program provided with IBM i. When this value is specified, the name of a PDF mapping object must be specified |
| PDF-mapping-program | The name of the user program to use for mapping. |
Mapping program library. The name of the library in which the mapping program is located.
Multiple PDF files. Specifies if PSF should tell the IPDS to PDF transform to split the PDF output into multiple PDF files at the DDS keyword STRPAGGRP boundaries. This field is used only when the generate PDF output field has a value other than *NONE; otherwise, it is set to blanks.
The possible values are:
| *NO | One PDF file should be generated. |
| *YES | Multiple PDF files should be created when applicable. |
Multiple PDF files process option. When Multiple PDF files is yes, specifies how PSF should tell the IPDS to PDF transform to split the PDF output into multiple PDF files at the DDS keyword STRPAGGRP boundaries. This field is used only when the generate PDF output field has a value other than *NONE; otherwise, it is set to blanks.
The possible values are:
| *SPLIT | Multiple PDF output files will be generated at group boundaries. |
| *INDEX | An index tag or bookmark will be placed at the group boundaries in a single output file. If *INDEX is requested, bookmarks will be labeled according to the group name on the DDS STRPAGGRP keyword. If characters in the group name are not available in the stardard PDF encoding they will be presented as a space. |
Number of additional generate PDF output options The number of additional options to generate PDF.
Number of device resource library list entries. The number of resource library list entries returned.
Number of mail server names The number of mail server names to use for electronically mailing the resulting PDF file from the IPDS to PDF transform.
Number of PSF-defined options. The number of PSF-defined options returned.
Offset to additional generate PDF output options. The number of bytes from the start of the PSFI0100 format to the beginning of the additional options to generate PDF.
Offset to device resource library list entries. The number of bytes from the start of the PSFI0100 format to the beginning of the first device resource library list entry.
Offset to mail server names The number of bytes from the start of the PDFI0100 format to the beginning of the first mail server name to use for electronically mailing the resulting PDF file from the IPDS to PDF transform.
Offset to PSF-defined options. The number of bytes from the start of the PSFI0100 format to the beginning of the first PSF-defined option.
Output queue. The name of the output queue that should be used when spooling PDF output. This field is used only when the generate PDF output field has a value of *SPLF; otherwise, it is set to blanks.
Possible values are:
| *NONE | No output queue is specified. |
| output-queue-name | The name of the output queue. |
Output queue library. The name of the library in which the output queue is located. This field is used only when the generate PDF output field has a value of *SPLF; otherwise, it is set to blanks.
Page size control. Whether the page size (forms) in the printer is set by PSF/400.
The possible values are:
| *NO | The page size (forms) in the printer is not set by PSF/400. |
| *YES | The page size (forms) in the printer is set by PSF/400. |
Paper size for drawer 1. The paper size to use for drawer 1 during the IPDS to PDF transfrom process. This field is used only when the generate PDF output field has a value other than *NONE; otherwise, it is set to blanks.
Possible values are:
| *LETTER | Use the dimensions of letter paper. |
| *LEGAL | Use the dimensions of legal paper. |
| *STATEMENT | Use the dimensions of statement paper. |
| *EXECUTIVE | Use the dimensions of executive paper. |
| *LEDGER | Use the dimensions of ledger paper. |
| *A5 | Use the dimensions of A5 paper. |
| *A4 | Use the dimensions of A4 paper. |
| *A3 | Use the dimensions of A3 paper. |
| *B5 | Use the dimensions of B5 paper. |
| *B4 | Use the dimensions of B5 paper. |
Paper size for drawer 2. The paper size to use for drawer 2 during the IPDS to PDF transfrom process. This field is used only when the generate PDF output field has a value other than *NONE; otherwise, it is set to blanks.
Possible values are:
| *LETTER | Use the dimensions of letter paper. |
| *LEGAL | Use the dimensions of legal paper. |
| *STATEMENT | Use the dimensions of statement paper. |
| *EXECUTIVE | Use the dimensions of executive paper. |
| *LEDGER | Use the dimensions of ledger paper. |
| *A5 | Use the dimensions of A5 paper. |
| *A4 | Use the dimensions of A4 paper. |
| *A3 | Use the dimensions of A3 paper. |
| *B5 | Use the dimensions of B5 paper. |
| *B4 | Use the dimensions of B5 paper. |
PDF administrator. The e-mail address of an administrator that will receive a notification when one or more portions of a document can not be processed correctly.
Possible values are:
| *NONE | No PDF administrator e-mail address is specified. |
| PDF administrator | The e-mail address of the PDF administrator who will receive a notification when one or more portiions of a document can not be processed correctly. |
PDF fonts inline. Specifies whether the PDF output generated by the IPDS to PDF transform should carry the necessary fonts inline.
| *YES | Specifies that the fonts should be carried inline with the PDF output. |
| *NO | Specifies that the fonts should not be carried inline with the PDF output. |
Printer response timer. The length of time for which a writer should wait for a response from a printer device.
The possible values are:
| 5 to 3600 | The amount of time, in seconds, to wait. |
| -1 | There is no limit on the length of time a writer will wait for a response from the printer. (*NOMAX) |
PSF configuration object library. The library from which the PSF/400 configuration object was retrieved.
PSF configuration object name. The name of the PSF/400 configuration object retrieved.
PSF-defined option. A value as defined by IBM. One or more values may be made available between releases of IBM i (i5/OS, OS/400®). If a value is made available, a PTF cover letter will contain the required syntax.
The following special value may be returned:
| *NONE | No PSF-defined options are specified. |
Release timer. The amount of time to wait after the last page of the last ready spooled file has printed, before releasing the printer.
The possible values are:
| 1 to 1440 | The amount of time, in minutes, to wait. |
| 0 | The printer is not released unless ENDWTR is executed (*NOMAX). |
| -1 | PSF/400 waits 15 seconds before releasing the printer (*SEC15). |
| -2 | PSF/400 waits 30 seconds before releasing the printer (*SEC30). |
Reserved. An ignored field.
Resource retention. Whether PSF/400 should use resource retention across spooled files.
The possible values are:
| *YES | PSF/400 stores page segments and overlays in the printer across spooled file boundaries. |
| *NO | PSF/400 does not store page segments and overlays in the printer across spooled file boundaries. |
Restart timer. The amount of time to wait before the printer writer attempts to reestablish either a session or dialog.
The possible values are:
| 1 to 1440 | The number of minutes to wait. |
| 0 | The printer writer attempts to reestablish the session or dialog as soon as a spooled file has a status of RDY (*IMMED). |
Save AFP data. The activation of the save AFP data capability.
Possible values are:
| *NO | No AFP Respool allowed. |
| *YES | AFP Respool allowed. |
Sender of electronic mail. The owner or sender from whom the PDF output file is electronically mailed. This field is used only when the generate PDF output field has a value of *MAIL; otherwise, it is set to blanks.
The possible values are:
| *SPLFOWN | The owner of the original spooled file should be the sender of the electronically mailed PDF file. |
| mail-file-sender | The name of a valid user profile to be used as the sender of the electronically mailed PDF file. |
Text. The text that briefly describes the object.
Use DBCS simulation fonts. Whether to use outline DBCS simulation fonts.
The possible values are:
| *NO | No mapping of coded fonts will be done. |
| *YES | All coded font references will be mapped to outline coded font equivalents. |
User resource library. The user resource library list to be used for searching AFP resources. The user resource library list is searched first and then the device resource library list is searched when attempting to find an AFP resource specified with the spooled file.
The possible values are:
| *JOBLIBL | The job's current library list that created the spooled file is used in searching for AFP resources. |
| *PRTF | The list supplied in the printer file will be used in searching for AFP resources. |
| *CURLIB | The current library for the job that created the spooled file is used in searching for AFP resources. |
| *NONE |
No user resource library list is used in searching for AFP resources.
The following table shows the information returned for the CFNI0100 format.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Bytes returned |
| 4 | 4 | BINARY(4) | Bytes available |
| 8 | 8 | CHAR(10) | Coded font name |
| 18 | 12 | CHAR(10) | Coded font library name |
| 28 | 1C | CHAR(50) | Text |
| 78 | 4E | CHAR(2) | Reserved |
| 80 | 50 | BINARY(4) | Offset to the font character set and code page pairs contained in the coded font |
| 84 | 54 | BINARY(4) | Number of font character set and code page pairs contained in the coded font |
| 88 | 58 | BINARY(4) | Length of a font character set and code page pair |
| These fields are repeated for each font character set and code page pair contained in the coded font. | CHAR(10) | Font sharacter set | |
| CHAR(10) | Host code page | ||
| CHAR(10) | Resident font | ||
| CHAR(2) | Reserved | ||
The following table shows the information returned for the FCSI0100 format.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Bytes returned |
| 4 | 4 | BINARY(4) | Bytes available |
| 8 | 8 | CHAR(10) | Font character set |
| 18 | 12 | CHAR(2) | Reserved |
| 20 | 14 | BINARY(4) | Offset to the coded font entries |
| 24 | 18 | BINARY(4) | Number of coded fonts |
| 28 | 1C | BINARY(4) | Length of data returned for each coded font |
| These fields are repeated for each coded font that contains the font character set specified with the font character set parameter. | CHAR(10) | Coded font name | |
| CHAR(10) | Coded font library name | ||
| CHAR(50) | Text | ||
| CHAR(2) | Reserved | ||
Bytes available. The length of all data available to return. All available data is returned if enough space is provided.
Bytes returned. The length of the data actually returned.
Coded font library name. The library of the coded font being retrieved.
Coded font name. The name of the coded font being retrieved.
Font character set. The name of a font character set that is contained in the coded font.
Host code page. The name of the host resident code page font resource that is contained in the coded font.
Length of data returned for each coded font. The length, in bytes, of the data returned for each coded font that contains the font character set specified with the font character set parameter.
Length of a font character set and code page pair. The length, in bytes, of the data returned for each font character set and code page pair.
Number of coded fonts. The number of coded fonts that contain the font character set specified with the font character set parameter.
Number of font character set and code page pairs in the coded font. The number of font character set and code page pairs that are contained in the coded font.
Offset to the coded font entries. The number of bytes from the start of the FCSI0100 format to the beginning of the first coded font entry.
Offset to the font character set and code page pairs in the coded font. The number of bytes from the start of the CFNI0100 format to the beginning of the first font character set and code page pair.
Reserved. An ignored field.
Resident font. Whether the font character set and code page pair is resident in the printer.
The possible values are:
| *YES | The font character set and code page pair is resident in the printer and does not need to be downloaded by the system to the printer. |
| *NO | The font character set and code page pair is not resident in the printer and needs to be downloaded by the system to the printer. |
Text. The text that briefly describes the object.
The following table shows the information returned for the FTBI0100 format.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Bytes returned |
| 4 | 4 | BINARY(4) | Bytes available |
| 8 | 8 | CHAR(10) | Font table name |
| 18 | 12 | CHAR(10) | Font table library |
| 28 | 1C | CHAR(50) | Text |
| 78 | 4E | CHAR(10) | Font table type |
| 88 | 58 | BINARY(4) | Number of entries in font table |
| 92 | 5C | BINARY(4) | Maximum length of each font table entry |
The following table shows the information returned for the PHCS0100 format.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Bytes returned |
| 4 | 4 | BINARY(4) | Bytes available |
| 8 | 8 | CHAR(10) | Font table name |
| 18 | 12 | CHAR(10) | Font table library |
| 28 | 1C | CHAR(50) | Text |
| 78 | 4E | CHAR(2) | Reserved |
| 80 | 50 | BINARY(4) | Offset to first entry in font table |
| 84 | 54 | BINARY(4) | Number of entries in font table |
| 88 | 58 | BINARY(4) | Length of font table entry |
| These fields are repeated for each entry in the font table. | BINARY(4) | Printer font identifier | |
| CHAR(10) | Width | ||
| CHAR(12) | Attribute | ||
| CHAR(10) | Graphic character set | ||
| CHAR(10) | Point size | ||
| CHAR(10) | Host font character | ||
| CHAR(10) | Host font character (1) | ||
| CHAR(10) | Host font character (2) | ||
| CHAR(10) | Type | ||
| CHAR(2) | Reserved | ||
The following table shows the information returned for the HPCS0100 format.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Bytes returned |
| 4 | 4 | BINARY(4) | Bytes available |
| 8 | 8 | CHAR(10) | Font table name |
| 18 | 12 | CHAR(10) | Font table library |
| 28 | 1C | CHAR(50) | Text |
| 78 | 4E | CHAR(2) | Reserved |
| 80 | 50 | BINARY(4) | Offset to first entry in font table |
| 84 | 54 | BINARY(4) | Number of entries in font table |
| 88 | 58 | BINARY(4) | Length of font table entry |
| These fields are repeated for each entry in the font table. | CHAR(10) | Host font character | |
| CHAR(10) | Type | ||
| BINARY(4) | Printer font identifier | ||
| CHAR(10) | Width | ||
| CHAR(12) | Attribute | ||
| CHAR(10) | Graphic character set | ||
| CHAR(10) | Point size | ||
| CHAR(2) | Reserved | ||
The following table shows the information returned for the PHCP0100 format.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Bytes returned |
| 4 | 4 | BINARY(4) | Bytes available |
| 8 | 8 | CHAR(10) | Font table name |
| 18 | 12 | CHAR(10) | Font table library |
| 28 | 1C | CHAR(50) | Text |
| 78 | 4E | CHAR(2) | Reserved |
| 80 | 50 | BINARY(4) | Offset to first entry in font table |
| 84 | 54 | BINARY(4) | Number of entries in font table |
| 88 | 58 | BINARY(4) | Length of font table entry |
| These fields are repeated for each entry in the font table | CHAR(10) | Graphic character set | |
| CHAR(5) | Code page | ||
| CHAR(10) | Host code page | ||
| CHAR(10) | Host code page (1) | ||
| CHAR(10) | Host code page (2) | ||
| CHAR(3) | Reserved | ||
The following table shows the information returned for the HPCP0100 format.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Bytes returned |
| 4 | 4 | BINARY(4) | Bytes available |
| 8 | 8 | CHAR(10) | Font table name |
| 18 | 12 | CHAR(10) | Font table library |
| 28 | 1C | CHAR(50) | Text |
| 78 | 4E | CHAR(2) | Reserved |
| 80 | 50 | BINARY(4) | Offset to first entry in font table |
| 84 | 54 | BINARY(4) | Number of entries in font table |
| 88 | 58 | BINARY(4) | Length of font table entry |
| These fields are repeated for each entry in the font table. | CHAR(10) | Host code page | |
| CHAR(10) | Graphic character set | ||
| CHAR(5) | Code page | ||
| CHAR(3) | Reserved | ||
The following table shows the information returned for the PPCS0100 format.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Bytes returned |
| 4 | 4 | BINARY(4) | Bytes available |
| 8 | 8 | CHAR(10) | Font table name |
| 18 | 12 | CHAR(10) | Font table library |
| 28 | 1C | CHAR(50) | Text |
| 78 | 4E | CHAR(2) | Reserved |
| 80 | 50 | BINARY(4) | Offset to first entry in font table |
| 84 | 54 | BINARY(4) | Number of entries in font table |
| 88 | 58 | BINARY(4) | Length of font table entry |
| These fields are repeated for each entry in the font table. | BINARY(4) | From printer font ID | |
| CHAR(10) | From point size | ||
| CHAR(2) | Reserved | ||
| BINARY(4) | To printer font ID | ||
| CHAR(10) | To Point Size | ||
| CHAR(2) | Reserved | ||
Attribute. The attributes of the printer-resident font.
The possible attributes are:
| *NONE | This printer-resident font has no special font attributes. |
| *BOLD | The printer-resident font is a bold font. |
| *ITALIC | The printer-resident font is an italic font. |
| *BOLDITC | The printer-resident font is a bold italic font. |
| *DBLWIDE | The printer-resident font is a double-wide font. |
| *ITCDBLWIDE | The printer-resident font is an italic double-wide font. |
| *BOLDDBLWIDE | The printer-resident font is a bold double-wide font. |
Bytes available. The length of all data available to return. All available data is returned if enough space is provided.
Bytes returned. The length of the data actually returned.
Code page. The printer-resident code page for which substitution is performed.
Font table library. The name of the library in which the font table is found. This value is blank when the font table name specified in the qualified AFP object is *SYSPHFCS, *SYSHPFCS, *SYSPHCP or *SYSHPCP.
Font table name. The name of the font table retrieved.
When the qualified AFP object is *SYSPHFCS, the font table name is
*SYSPHFCS.
When the qualified AFP object is *SYSPHCP, the font table name is *SYSPHCP.
When the qualified AFP object is *SYSHPFCS, the font table name is
*SYSHPFCS.
When the qualified AFP object is *SYSHPCP, the font table name is *SYSHPCP.
Font table type. The type of font table.
The possible types are:
| *PHFCS | The font table is a printer-resident to host-resident font character set table. |
| *SYSPHFCS | The font table is the system printer-resident to host-resident font character set table. |
| *PHCP | The font table is a printer-resident to host-resident code page mapping table. |
| *SYSPHCP | The font table is the system printer-resident to host-resident code page mapping table. |
| *HPFCS | The font table is a host-resident to printer-resident font character set table. |
| *SYSHPFCS | The font table is the system host-resident to printer-resident font character set table. |
| * | The font table is a host-resident to printer-resident code page mapping table. |
| *SYSHPCP | The font table is the system host-resident to printer-resident code page mapping table. |
| *PPFCS | The font table is a printer-resident to printer-resident font subsitution table. |
From point size. The point size of the printer-resident font for which substitution is performed.
The possible values are:
| *WIDTH | The width of the printer-resident font is used to compute the point size. |
| *NONE | No point size is specified for this font identifier. |
| *ALL | All point sizes for a scalable font are mapped. If the font is not scalable, then this is treated the same as *NONE. |
| 0.1 to 999.9. | Numeric value of the point size. This value is right-justified and padded with leading 0's. |
From printer font ID. The printer font identifier for which substitution is performed.
Graphic character set. The graphic character set for the font identifier.
The possible values are:
| *SYSVAL | The graphic character set value specified in the system value QCHRID is used. |
| graphic-character-set | The graphic character set value specified for the font identifier. |
Host code page. The host code page specified for substitution. This value is blank if the qualified AFP object name is *SYSPHCP.
Host code page (1). The first host code page selected for font substitution. If this host code page is not available, PSF/400 checks for the existence of host code page (2). This value is blank if the qualified AFP object name is not *SYSPHCP.
Host code page (2). The second host code page selected for font substitution if the first font code page is not available. A blank entry means that a second host code page is not available. This value is also blank if the qualified AFP object name is not *SYSPHCP.
Host font character. The host font character set specified for font substitution. This value is blank if the qualified AFP object name is *SYSPHFCS.
Host font character (1). The first host font character set selected for font substitution. If this host font character set is not available, PSF/400 checks for the existence of host font character (2). This value is blank if the qualified AFP object name is not *SYSPHFCS.
Host font character (2). The second host font character set selected for font substitution if the first font character set is not available. A blank entry means that a second host font character set is not available. This value is also blank if the qualified AFP object name is not *SYSPHFCS.
Length of font table entry. Length, in bytes, of each font table entry.
Maximum length of each font table entry. Maximum length, in bytes, of each font table entry.
Number of entries in font table. The number of font table entries returned.
Offset to first entry in font table. The number of bytes from the start of the PHCS0100, HPCS0100, PHCP0100, HPCP0100, or PPCS0100 format to the beginning of the first font table entry.
Point size. The point size of the printer-resident font.
The possible values are:
| *WIDTH | The width of the printer-resident font is used to compute the point size. |
| *NONE | No point size is specified for this font identifier. |
| 0.1 to 999.9. | Numeric value of the point size. This value is right-justified and padded with leading 0's. |
Printer font identifier. The printer font identifier for which substitution is performed.
The possible values are:
| 0 | The mapping of a host-resident to printer-resident font is disabled. (*NONE) |
| 1 to 65535 | The printer font identifier. |
Reserved. An ignored field.
Text. The text that briefly describes the object.
To point size. The point size of the printer resident font identifier.
The possible values are:
| *NONE: | No font point size is specified. This should be specified for all non-scalable fonts. |
| *ALL | All point sizes for a scalable font are mapped. If the font is not scalable, then this is treated the same as *NONE. |
| 0.1 to 999.9. | Numeric value of the point size. This value is right-justified and padded with leading 0's. |
To printer font ID. The font identifier of the printer resident font.
Type. The type of host font specified.
| *OUTLINE | The host-resident font is an outline font. |
| *RASTER | The host-resident font is a raster font. |
Width. The width of the printer-resident font.
The possible values are:
| *PTSIZE | The width for this font identifier is calculated from the point size. |
| *NONE | No width is specified for this font identifier. *NONE should be specified when mapping an outline font. |
| 1 to 32767 | The font width for the font identifier. See the Printing topic for information on font widths for printer-resident fonts. |
| Message ID | Error Message Text |
|---|---|
| CPF3700 E | |
| CPF0001 E | Error found on &1 command. |
| CPD0172 D | Parameters passed on CALL do not match those required. |
| CPF2150 E | Object information function failed. |
| CPF2151 E | Operation failed for &2 in &1 type *&3. |
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF3C17 E | Error occurred with input data parameter. |
| CPF3C19 E | Error occurred with receiver variable specified. |
| CPF3C1E E | Required parameter &1 omitted. |
| CPF3C20 E | Error found by program &1. |
| CPF3C21 E | Format name &1 is not valid. |
| CPF3C24 E | Length of the receiver variable is not valid. |
| CPF3C29 E | Object name &1 is not valid. |
| CPF3C36 E | Number of parameters, &1, entered for this API was not valid. |
| CPF3C3C E | Value for parameter &1 not valid. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF3CF2 E | Error(s) occurred during running of &1 API. |
| CPF8100 E | All CPF81xx messages could be returned. xx is from 01 to FF. |
| CPF9801 E | Object &2 in library &3 not found. |
| CPF9802 E | Not authorized to object &2 in &3. |
| CPF9803 E | Cannot allocate object &2 in library &3. |
| CPF9808 E | Cannot allocate one or more libraries on library list. |
| CPF9810 E | Library &1 not found. |
| CPF9820 E | Not authorized to use library &1. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
| CPF9999 E | Function check. &1 unmonitored by &2 at statement &5, instruction &3. |
| PQT0107 E | No coded fonts found containing specified font character set. |
[ Back to top | Print APIs | APIs by category ]