| 1 | Receiver variable | Output | Char(*) |
| 2 | Length of receiver variable | Input | Binary(4) |
| 3 | List information | Output | Char(80) |
| 4 | Number of records to return | Input | Binary(4) |
| 5 | Format name | Input | Char(8) |
| 6 | Qualified AFP™ object name | Input | Char(20) |
| 7 | Format qualifier | Input | Char(10) |
| 8 | Error code | I/O | Char(*) |
The Open List of AFP Information (QGYOLAFP) API lists entries from a font mapping table or list font character set or code page information from a coded font and places the list in a receiver variable. You can access additional records by using the Get List Entries (QGYGTLE) API. On successful completion of the API, a handle is returned in the list information parameter. You may use this handle on subsequent calls to the following APIs:
The variable used to return the number of records requested (given in the number of records to return parameter). The structure of the receiver variable varies depending on which format is requested (format parameter).
The length of the receiver variable provided. This must be large enough to hold at least one record.
Information about the list of objects that was opened. For a description of the layout of this parameter, see Open list information format.
The number of records in the list to put into the receiver variable.
The format of the information to be returned for the specified object. The valid format names are:
| CFNI0100 | Information about the specified coded font. |
| FCSI0100 | Information about the specified font character set. |
| PHCS0100 | Information about the specified font table. |
| HPCS0100 | 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 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 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 in which the object is located when the format name is CFNI0100, PHCS0100, HPCS0100, PHCP0100, HPCP0100, or PPCS0100, and a special value is not specified for the AFP object name.
The following special values are allowed when the format name is CFNI0100, 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 CFNI0100 format.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | Font character set |
| 10 | A | CHAR(10) | Host code page |
| 20 | 14 | CHAR(10) | Resident font |
| 30 | 1E | CHAR(2) | Reserved |
The following table shows the information returned for the FCSI0100 format.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | Coded font name |
| 10 | A | CHAR(10) | Coded font library name |
| 20 | 14 | CHAR(50) | Text |
| 70 | 46 | CHAR(2) | Reserved |
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.
Reserved. An ignored field.
Resident font. Whether the font character set and code page pair are resident in the printer.
The possible values are:
| *YES | The font character set/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/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 PHCS0100 format.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Printer font identifier |
| 4 | 4 | CHAR(10) | Width |
| 14 | E | CHAR(12) | Attribute |
| 26 | 1A | CHAR(10) | Graphic character set |
| 36 | 24 | CHAR(10) | Point size |
| 46 | 2E | CHAR(10) | Host font character |
| 56 | 38 | CHAR(10) | Host font character (1) |
| 66 | 42 | CHAR(10) | Host font character (2) |
| 76 | 4C | CHAR(10) | Type |
| 86 | 56 | CHAR(2) | Reserved |
The following table shows the information returned for the HPCS0100 format.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | Host font character |
| 10 | A | CHAR(10) | Type |
| 20 | 14 | BINARY(4) | Printer font identifier |
| 24 | 18 | CHAR(10) | Width |
| 34 | 22 | CHAR(12) | Attribute |
| 46 | 2E | CHAR(10) | Graphic character set |
| 56 | 38 | CHAR(10) | Point size |
| 66 | 42 | CHAR(2) | Reserved |
The following table shows the information returned for the PHCP0100 format.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | Graphic character set |
| 10 | A | CHAR(5) | Code page |
| 15 | F | CHAR(10) | Host code page |
| 25 | 19 | CHAR(10) | Host code page (1) |
| 35 | 23 | CHAR(10) | Host code page (2) |
| 45 | 2D | CHAR(3) | Reserved |
The following table shows the information returned for the HPCP0100 format.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | Host code page |
| 10 | A | CHAR(10) | Graphic character set |
| 20 | 14 | CHAR(5) | Code page |
| 25 | 19 | CHAR(3) | Reserved |
The following table shows the information returned for the PPCS0100 format.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | From printer font ID |
| 4 | 4 | CHAR(10) | From point size |
| 14 | E | CHAR(2) | Reserved |
| 16 | 10 | BINARY(4) | To printer font ID |
| 20 | 14 | CHAR(10) | To point size |
| 30 | 1E | 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. |
Code page. The printer-resident code page for which substitution is performed.
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 will be mapped. If the font is not scalable, then this will 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.
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.
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 will be mapped. If the font is not scalable, then this will 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 |
|---|---|
| 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 ]