friedkiwi/ibm-information-center
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
master
ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/qgyolafp.htm

1361 lines
36 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
<title>Open List of AFP Information (QGYOLAFP) API</title>
<!-- Begin Header Records -->
<!-- All rights reserved. Licensed Materials Property of IBM -->
<!-- US Government Users Restricted Rights -->
<!-- Use, duplication or disclosure restricted by -->
<!-- GSA ADP Schedule Contract with IBM Corp. -->
<!-- Created by Tim Aden for V5R1-->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!--File Edited Kersten Oct 2001 -->
<!-- End Header Records -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body>
<a name="Top_Of_Page"></a>
<!--Java sync-link-->
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript">
</script>
<h2>Open List of AFP Information (QGYOLAFP) API</h2>
<div class="box" style="width: 75%;">
<br>
&nbsp;&nbsp;Required Parameter Group:<br>
<!-- iddvc RMBR -->
<br>
<table width="100%">
<tr>
<td align="center" valign="top" width="10%">1</td>
<td align="left" valign="top" width="50%">Receiver variable</td>
<td align="left" valign="top" width="20%">Output</td>
<td align="left" valign="top" width="20%">Char(*)</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">Length of receiver variable</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Binary(4)</td>
</tr>
<tr>
<td align="center" valign="top">3</td>
<td align="left" valign="top">List information</td>
<td align="left" valign="top">Output</td>
<td align="left" valign="top">Char(80)</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="left" valign="top">Number of records to return</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Binary(4)</td>
</tr>
<tr>
<td align="center" valign="top">5</td>
<td align="left" valign="top">Format name</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(8)</td>
</tr>
<tr>
<td align="center" valign="top">6</td>
<td align="left" valign="top">Qualified AFP object name</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(20)</td>
</tr>
<tr>
<td align="center" valign="top">7</td>
<td align="left" valign="top">Format qualifier</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(10)</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="left" valign="top">Error code</td>
<td align="left" valign="top">I/O</td>
<td align="left" valign="top">Char(*)</td>
</tr>
</table>
<br>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>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:</p>
<ul>
<li>Get List Entries (QGYGTLE)</li>
<li>Find Entry Number in List (QGYFNDE)</li>
<li>Close List (QGYCLST)</li>
</ul>
<br>
<h3>Authorities and Locks</h3>
<dl>
<dt><em>Library authority</em></dt>
<dd>*EXECUTE</dd>
<dt><em>Font table authority</em></dt>
<dd>*USE</dd>
<dt><em>Font resource authority</em></dt>
<dd>*USE</dd>
<dt><em>Font table lock</em></dt>
<dd>*SHRRD</dd>
<dt><em>Font resource lock</em></dt>
<dd>*SHRRD</dd>
</dl>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Receiver variable</strong></dt>
<dd>OUTPUT; CHAR(*)
<p>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).</p>
</dd>
<dt><strong>Length of Receiver variable</strong></dt>
<dd>INPUT; BINARY(4)
<p>The length of the receiver variable provided. This must be large enough to
hold at least one record.</p>
</dd>
<dt><strong>List information</strong></dt>
<dd>OUTPUT; CHAR(80)
<p>Information about the list of objects that was opened. For a description of
the layout of this parameter, see <a href="../apiref/oli.htm">Format of Open List
Information</a>.</p>
</dd>
<dt><strong>Number of records to return</strong></dt>
<dd>INPUT; BINARY(4)
<p>The number of records in the list to put into the receiver variable.</p>
</dd>
<dt><strong>Format name</strong></dt>
<dd>INPUT; CHAR(8)
<p>The format of the information to be returned for the specified object. The
valid format names are:</p>
<table cellpadding="5">
<!-- cols="25 75" -->
<tr>
<td align="left" valign="top"><em><a href="#HDRINFO201">CFNI0100</a></em></td>
<td align="left" valign="top">Information about the specified coded font.</td>
</tr>
<tr>
<td align="left" valign="top"><em><a href="#HDRINFO202">FCSI0100</a></em></td>
<td align="left" valign="top">Information about the specified font character set.</td>
</tr>
<tr>
<td align="left" valign="top"><em><a href="#HDRINFO301">PHCS0100</a></em></td>
<td align="left" valign="top">Information about the specified font table.</td>
</tr>
<tr>
<td align="left" valign="top"><em><a href="#HDRINFO302">HPCS0100</a></em></td>
<td align="left" valign="top">Information about the specified font table.</td>
</tr>
<tr>
<td align="left" valign="top"><em><a href="#HDRINFO304">HPCP0100</a></em></td>
<td align="left" valign="top">Information about the specified font table.</td>
</tr>
<tr>
<td align="left" valign="top"><em><a href="#HDRINFO305">PPCS0100</a></em></td>
<td align="left" valign="top">Information about the specified font table.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Qualified AFP object name</strong></dt>
<dd>INPUT; CHAR(20)
<p>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.</p>
<p>You may not use special values for the object name when the format name is
PPCS0100.</p>
<p>You must use the following special value for the object name when the format
name is FCSI0100:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*FNTCHRSET</em></td>
<td align="left" valign="top">All coded fonts that contain the font character
set specified by the font character set parameter are returned.</td>
</tr>
</table>
<br>
<p>You may use one of the following special values for the object name when the
format name is PHCS0100:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*PHFCS</em></td>
<td align="left" valign="top">The printer-resident to host-resident font
character set table is to be returned.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*SYSPHFCS</em></td>
<td align="left" valign="top">The system printer-resident to host-resident font character
set table is to be returned.</td>
</tr>
</table>
<br>
<p>You may use one of the following special values for the object name when the
format name is HPCS0100:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*HPFCS</em></td>
<td align="left" valign="top">The host-resident to printer-resident font
character set table is to be returned.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*SYSHPFCS</em></td>
<td align="left" valign="top">The system host-resident to printer-resident font character
set table is to be returned.</td>
</tr>
</table>
<br>
<p>You may use one of the following special values for the object name when the
format name is PHCP0100:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*PHCP</em></td>
<td align="left" valign="top">The printer-resident to host-resident code page
mapping table is to be returned.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*SYSPHCP</em></td>
<td align="left" valign="top">The system printer-resident to host-resident code page mapping
table is to be returned.</td>
</tr>
</table>
<br>
<p>You may use one of the following special values for the object name when the
format name is HPCP0100:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*HPCP</em></td>
<td align="left" valign="top">The host-resident to printer-resident code page
mapping table is to be returned.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*SYSHPCP</em></td>
<td align="left" valign="top">The system host-resident to printer-resident code page mapping
table is to be returned.</td>
</tr>
</table>
<br>
<p>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.</p>
<p>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.</p>
<p>The following special values are allowed when the format name is CFNI0100,
PHCS0100, HPCS0100, PHCP0100, HPCP0100, or PPCS0100:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*CURLIB</em></td>
<td align="left" valign="top">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.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*LIBL</em></td>
<td align="left" valign="top">The library list is used to locate the object.</td>
</tr>
</table>
<br>
<p>The actual library that is used is returned with the object information.</p>
<p>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.</p>
<p>The following special values are allowed when the Format name is
FCSI0100:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*CURLIB</em></td>
<td align="left" valign="top">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.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*LIBL</em></td>
<td align="left" valign="top">All libraries in the job's library list are searched.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*USRLIBL</em></td>
<td align="left" valign="top">Only the libraries listed in the user portion of the job's
library list are searched.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">All libraries in the system, including QSYS, are
searched.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*ALLUSR</em></td>
<td align="left" valign="top">All user libraries are searched. For information on the
libraries included, see <a href="../apiref/genericlibname.htm#allusr">*ALLUSR</a> in Generic library names.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*DBCSFNTLIB</em></td>
<td align="left" valign="top">The DBCS font libraries QFNT61, QFNT62, QFNT63, QFNT64, and
QFNT65 will be searched.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Format qualifier</strong></dt>
<dd>INPUT; CHAR(10)
<p>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.</p>
<p>This parameter must be blank if the format name is not FCSI0100.</p>
</dd>
<dt><strong>Error code</strong></dt>
<dd>I/O; CHAR(*)
<p>The structure in which to return error information. For the format of the
structure, see <a href="../apiref/error.htm#hdrerrcod">Error Code Parameter</a>.</p>
</dd>
</dl>
<br>
<h3><a name="HDRINFO201">CFNI0100 Format</a></h3>
<p>The following table shows the information returned for the CFNI0100
format.</p>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="bottom">Dec</th>
<th align="center" valign="bottom">Hex</th>
</tr>
<tr>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">0</td>
<td align="left" valign="top" width="20%">CHAR(10)</td>
<td align="left" valign="top" width="60%">Font character set</td>
</tr>
<tr>
<td align="center" valign="top">10</td>
<td align="center" valign="top">A</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Host code page</td>
</tr>
<tr>
<td align="center" valign="top">20</td>
<td align="center" valign="top">14</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Resident font</td>
</tr>
<tr>
<td align="center" valign="top">30</td>
<td align="center" valign="top">1E</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Reserved</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRINFO202">FCSI0100 Format</a></h3>
<p>The following table shows the information returned for the FCSI0100
format.</p>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="bottom">Dec</th>
<th align="center" valign="bottom">Hex</th>
</tr>
<tr>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">0</td>
<td align="left" valign="top" width="20%">CHAR(10)</td>
<td align="left" valign="top" width="60%">Coded font name</td>
</tr>
<tr>
<td align="center" valign="top">10</td>
<td align="center" valign="top">A</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Coded font library name</td>
</tr>
<tr>
<td align="center" valign="top">20</td>
<td align="center" valign="top">14</td>
<td align="left" valign="top">CHAR(50)</td>
<td align="left" valign="top">Text</td>
</tr>
<tr>
<td align="center" valign="top">70</td>
<td align="center" valign="top">46</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Reserved</td>
</tr>
</table>
<br>
<br>
<h3>Field Descriptions</h3>
<p><strong>Coded font library name.</strong> The library of the coded font
being retrieved.</p>
<p><strong>Coded font name.</strong> The name of the coded font being
retrieved.</p>
<p><strong>Font character set.</strong> The name of a font character set that
is contained in the coded font.</p>
<p><strong>Host code page.</strong> The name of the host resident code page
font resource that is contained in the coded font.</p>
<p><strong>Reserved.</strong> An ignored field.</p>
<p><strong>Resident font.</strong> Whether the font character set and code page
pair are resident in the printer.</p>
<p>The possible values are:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>*YES</em></td>
<td align="left" valign="top">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.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NO</em></td>
<td align="left" valign="top">The font character set/code page pair is not resident in the
printer and needs to be downloaded by the system to the printer.</td>
</tr>
</table>
<br>
<p><strong>Text.</strong> The text that briefly describes the object.</p>
<br>
<h3><a name="HDRINFO301">PHCS0100 Format</a></h3>
<p>The following table shows the information returned for the PHCS0100
format.</p>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="bottom">Dec</th>
<th align="center" valign="bottom">Hex</th>
</tr>
<tr>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">0</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Printer font identifier</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="center" valign="top">4</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Width</td>
</tr>
<tr>
<td align="center" valign="top">14</td>
<td align="center" valign="top">E</td>
<td align="left" valign="top">CHAR(12)</td>
<td align="left" valign="top">Attribute</td>
</tr>
<tr>
<td align="center" valign="top">26</td>
<td align="center" valign="top">1A</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Graphic character set</td>
</tr>
<tr>
<td align="center" valign="top">36</td>
<td align="center" valign="top">24</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Point size</td>
</tr>
<tr>
<td align="center" valign="top">46</td>
<td align="center" valign="top">2E</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Host font character</td>
</tr>
<tr>
<td align="center" valign="top">56</td>
<td align="center" valign="top">38</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Host font character (1)</td>
</tr>
<tr>
<td align="center" valign="top">66</td>
<td align="center" valign="top">42</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Host font character (2)</td>
</tr>
<tr>
<td align="center" valign="top">76</td>
<td align="center" valign="top">4C</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Type</td>
</tr>
<tr>
<td align="center" valign="top">86</td>
<td align="center" valign="top">56</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Reserved</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRINFO302">HPCS0100 Format</a></h3>
<p>The following table shows the information returned for the HPCS0100
format.</p>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="bottom">Dec</th>
<th align="center" valign="bottom">Hex</th>
</tr>
<tr>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">0</td>
<td align="left" valign="top" width="20%">CHAR(10)</td>
<td align="left" valign="top" width="60%">Host font character</td>
</tr>
<tr>
<td align="center" valign="top">10</td>
<td align="center" valign="top">A</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Type</td>
</tr>
<tr>
<td align="center" valign="top">20</td>
<td align="center" valign="top">14</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Printer font identifier</td>
</tr>
<tr>
<td align="center" valign="top">24</td>
<td align="center" valign="top">18</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Width</td>
</tr>
<tr>
<td align="center" valign="top">34</td>
<td align="center" valign="top">22</td>
<td align="left" valign="top">CHAR(12)</td>
<td align="left" valign="top">Attribute</td>
</tr>
<tr>
<td align="center" valign="top">46</td>
<td align="center" valign="top">2E</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Graphic character set</td>
</tr>
<tr>
<td align="center" valign="top">56</td>
<td align="center" valign="top">38</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Point size</td>
</tr>
<tr>
<td align="center" valign="top">66</td>
<td align="center" valign="top">42</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Reserved</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRINFO303">PHCP0100 Format</a></h3>
<p>The following table shows the information returned for the PHCP0100
format.</p>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="bottom">Dec</th>
<th align="center" valign="bottom">Hex</th>
</tr>
<tr>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">0</td>
<td align="left" valign="top" width="20%">CHAR(10)</td>
<td align="left" valign="top" width="60%">Graphic character set</td>
</tr>
<tr>
<td align="center" valign="top">10</td>
<td align="center" valign="top">A</td>
<td align="left" valign="top">CHAR(5)</td>
<td align="left" valign="top">Code page</td>
</tr>
<tr>
<td align="center" valign="top">15</td>
<td align="center" valign="top">F</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Host code page</td>
</tr>
<tr>
<td align="center" valign="top">25</td>
<td align="center" valign="top">19</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Host code page (1)</td>
</tr>
<tr>
<td align="center" valign="top">35</td>
<td align="center" valign="top">23</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Host code page (2)</td>
</tr>
<tr>
<td align="center" valign="top">45</td>
<td align="center" valign="top">2D</td>
<td align="left" valign="top">CHAR(3)</td>
<td align="left" valign="top">Reserved</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRINFO304">HPCP0100 Format</a></h3>
<p>The following table shows the information returned for the HPCP0100
format.</p>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="bottom">Dec</th>
<th align="center" valign="bottom">Hex</th>
</tr>
<tr>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">0</td>
<td align="left" valign="top" width="20%">CHAR(10)</td>
<td align="left" valign="top" width="60%">Host code page</td>
</tr>
<tr>
<td align="center" valign="top">10</td>
<td align="center" valign="top">A</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Graphic character set</td>
</tr>
<tr>
<td align="center" valign="top">20</td>
<td align="center" valign="top">14</td>
<td align="left" valign="top">CHAR(5)</td>
<td align="left" valign="top">Code page</td>
</tr>
<tr>
<td align="center" valign="top">25</td>
<td align="center" valign="top">19</td>
<td align="left" valign="top">CHAR(3)</td>
<td align="left" valign="top">Reserved</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRINFO305">PPCS0100 Format</a></h3>
<p>The following table shows the information returned for the PPCS0100
format.</p>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="bottom">Dec</th>
<th align="center" valign="bottom">Hex</th>
</tr>
<tr>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">0</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">From printer font ID</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="center" valign="top">4</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">From point size</td>
</tr>
<tr>
<td align="center" valign="top">14</td>
<td align="center" valign="top">E</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">16</td>
<td align="center" valign="top">10</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">To printer font ID</td>
</tr>
<tr>
<td align="center" valign="top">20</td>
<td align="center" valign="top">14</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">To point size</td>
</tr>
<tr>
<td align="center" valign="top">30</td>
<td align="center" valign="top">1E</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Reserved</td>
</tr>
</table>
<br>
<br>
<h3>Field Descriptions</h3>
<p><strong>Attribute.</strong> The attributes of the printer-resident font.</p>
<p>The possible attributes are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*NONE</em></td>
<td align="left" valign="top">This printer-resident font has no special font
attributes.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*BOLD</em></td>
<td align="left" valign="top">The printer-resident font is a bold font.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*ITALIC</em></td>
<td align="left" valign="top">The printer-resident font is an italic font.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*BOLDITC</em></td>
<td align="left" valign="top">The printer-resident font is a bold italic font.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*DBLWIDE</em></td>
<td align="left" valign="top">The printer-resident font is a double wide font.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*ITCDBLWIDE</em></td>
<td align="left" valign="top">The printer-resident font is an italic double wide font.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*BOLDDBLWIDE</em></td>
<td align="left" valign="top">The printer-resident font is a bold double wide font.</td>
</tr>
</table>
<br>
<p><strong>Code page.</strong> The printer-resident code page for which
substitution is performed.</p>
<p><strong>From point size.</strong> The point size of the printer-resident
font for which substitution is performed.</p>
<p>The possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*WIDTH</em></td>
<td align="left" valign="top">The width of the printer-resident font is used to
compute the point size.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NONE</em></td>
<td align="left" valign="top">No point size is specified for this font identifier.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">All point sizes for a scalable font will be mapped. If the
font is not scalable, then this will treated the same as *NONE.</td>
</tr>
<tr>
<td align="left" valign="top"><em>0.1 to 999.9.</em></td>
<td align="left" valign="top">Numeric value of the point size. This value is right justified
and padded with leading 0's.</td>
</tr>
</table>
<br>
<p><strong>From printer font ID.</strong> The printer font identifier for which
substitution is performed.</p>
<p><strong>Graphic character set.</strong> The graphic character set for the
font identifier.</p>
<p>The possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*SYSVAL</em></td>
<td align="left" valign="top">The graphic character set value specified in the
system value QCHRID is used.</td>
</tr>
<tr>
<td align="left" valign="top"><em>graphic-character-set</em></td>
<td align="left" valign="top">The graphic character set value specified for the font
identifier.</td>
</tr>
</table>
<br>
<p><strong>Host code page.</strong> The host code page specified for
substitution. This value is blank if the qualified AFP object name is
*SYSPHCP.</p>
<p><strong>Host code page (1).</strong> 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.</p>
<p><strong>Host code page (2).</strong> 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.</p>
<p><strong>Host font character.</strong> The host font character set specified
for font substitution. This value is blank if the qualified AFP object name is
*SYSPHFCS.</p>
<p><strong>Host font character (1).</strong> 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.</p>
<p><strong>Host font character (2).</strong> 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.</p>
<p><strong>Point size.</strong> The point size of the printer-resident
font.</p>
<p>The possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*WIDTH</em></td>
<td align="left" valign="top">The width of the printer-resident font is used to
compute the point size.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NONE</em></td>
<td align="left" valign="top">No point size is specified for this font identifier.</td>
</tr>
<tr>
<td align="left" valign="top"><em>0.1 to 999.9.</em></td>
<td align="left" valign="top">Numeric value of the point size. This value is right justified
and padded with leading 0's.</td>
</tr>
</table>
<br>
<p><strong>Printer font identifier.</strong> The printer font identifier for
which substitution is performed.</p>
<p>The possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The mapping of a host-resident to printer-resident
font is disabled. (*NONE)</td>
</tr>
<tr>
<td align="left" valign="top"><em>1 to 65535</em></td>
<td align="left" valign="top">The printer font identifier.</td>
</tr>
</table>
<br>
<p><strong>Reserved.</strong> An ignored field.</p>
<p><strong>To point size.</strong> The point size of the printer resident font
identifier.</p>
<p>The possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*NONE:</em></td>
<td align="left" valign="top">No font point size is specified. This should be
specified for all non-scalable fonts.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">All point sizes for a scalable font will be mapped. If the
font is not scalable, then this will treated the same as *NONE.</td>
</tr>
<tr>
<td align="left" valign="top" nowrap><em>0.1 to 999.9.</em></td>
<td align="left" valign="top">Numeric value of the point size. This value is right justified
and padded with leading 0's.</td>
</tr>
</table>
<br>
<p><strong>To printer font ID.</strong> The font identifier of the printer
resident font.</p>
<p><strong>Type.</strong></p>
<p>The type of host font specified:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*OUTLINE</em></td>
<td align="left" valign="top">The host-resident font is an outline font.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*RASTER</em></td>
<td align="left" valign="top">The host-resident font is a raster font.</td>
</tr>
</table>
<br>
<p><strong>Width.</strong> The width of the printer-resident font.</p>
<p>The possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*PTSIZE</em></td>
<td align="left" valign="top">The width for this font identifier is calculated
from the point size.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NONE</em></td>
<td align="left" valign="top">No width is specified for this font identifier. *NONE should
be specified when mapping an outline font.</td>
</tr>
<tr>
<td align="left" valign="top" nowrap><em>1 to 32767</em></td>
<td align="left" valign="top">The font width for the font identifier.
See the <a href="../rzahg/rzahgprint.htm">Printing</a> topic for information on font widths for
printer-resident fonts.
</td>
</tr>
</table>
<br>
<h3>Error Messages</h3>
<table width="100%" cellpadding="5">
<!-- cols="15 85" -->
<tr>
<th align="left" valign="top">Message ID</th>
<th align="left" valign="top">Error Message Text</th>
</tr>
<tr>
<td align="left" valign="top">CPF0001 E</td>
<td align="left" valign="top">Error found on &amp;1 command.</td>
</tr>
<tr>
<td align="left" valign="top">CPD0172 D</td>
<td align="left" valign="top">Parameters passed on CALL do not match those required.</td>
</tr>
<tr>
<td align="left" valign="top">CPF2150 E</td>
<td align="left" valign="top">Object information function failed.</td>
</tr>
<tr>
<td align="left" valign="top">CPF2151 E</td>
<td align="left" valign="top">Operation failed for &amp;2 in &amp;1 type *&amp;3.</td>
</tr>
<tr>
<td align="left" valign="top">CPF24B4 E</td>
<td align="left" valign="top">Severe error while addressing parameter list.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C17 E</td>
<td align="left" valign="top">Error occurred with input data parameter.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C19 E</td>
<td align="left" valign="top">Error occurred with receiver variable specified.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C1E E</td>
<td align="left" valign="top">Required parameter &amp;1 omitted.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C20 E</td>
<td align="left" valign="top">Error found by program &amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C21 E</td>
<td align="left" valign="top">Format name &amp;1 is not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C24 E</td>
<td align="left" valign="top">Length of the receiver variable is not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C29 E</td>
<td align="left" valign="top">Object name &amp;1 is not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C36 E</td>
<td align="left" valign="top">Number of parameters, &amp;1, entered for this API was not
valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C3C E</td>
<td align="left" valign="top">Value for parameter &amp;1 not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3CF1 E</td>
<td align="left" valign="top">Error code parameter not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3CF2 E</td>
<td align="left" valign="top">Error(s) occurred during running of &amp;1 API.</td>
</tr>
<tr>
<td align="left" valign="top">CPF8100 E</td>
<td align="left" valign="top">All CPF81xx messages could be returned. xx is from 01 to
FF.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9801 E</td>
<td align="left" valign="top">Object &amp;2 in library &amp;3 not found.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9802 E</td>
<td align="left" valign="top">Not authorized to object &amp;2 in &amp;3.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9803 E</td>
<td align="left" valign="top">Cannot allocate object &amp;2 in library &amp;3.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9808 E</td>
<td align="left" valign="top">Cannot allocate one or more libraries on library list.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9810 E</td>
<td align="left" valign="top">Library &amp;1 not found.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9820 E</td>
<td align="left" valign="top">Not authorized to use library &amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9872 E</td>
<td align="left" valign="top">Program or service program &amp;1 in library &amp;2 ended.
Reason code &amp;3.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9999 E</td>
<td align="left" valign="top">Function check. &amp;1 unmonitored by &amp;2 at statement
&amp;5, instruction &amp;3.</td>
</tr>
<tr>
<td align="left" valign="top">PQT0107 E</td>
<td align="left" valign="top">No coded fonts found containing specified font character
set.</td>
</tr>
</table>
<br>
<hr>
API introduced: V5R1
<hr>
<table cellpadding="2" cellspacing="2" align="center">
<tr align="center">
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
"print1.htm">Print APIs</a> | <a href="aplist.htm">APIs by
category</a></td>
</tr>
</table>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink