ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/QGSCPYRS.htm

735 lines
17 KiB
HTML
Raw Normal View History

2024-04-02 14:02:31 +00:00
<!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>Copy AFPDS Resource (QGSCPYRS) 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. -->
<!-- Print SCRIPT A converted by B2H R4.1 (346) (CMS) by V2KEA304 -->
<!-- at RCHVMW2 on 17 Feb 1999 at 11:05:09 -->
<!-- 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>Copy AFPDS Resource (QGSCPYRS) API</h2>
<div class="box" style="width: 70%;">
<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%">Qualified user space name</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">Char(20)</td>
</tr>
<tr>
<td align="center" valign="top">2</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">3</td>
<td align="left" valign="top">Qualified resource name</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(20)</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="left" valign="top">Resource object type</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(10)</td>
</tr>
<tr>
<td align="center" valign="top">5</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 Copy AFPDS Resource (QGSCPYRS) API puts an AFPDS data stream equivalent
of the specified AFPDS resource into the specified user space.</p>
<br>
<h3>Authorities and Locks</h3>
<dl>
<dt><em>User Space Authority</em></dt>
<dd>*CHANGE</dd>
<dt><em>User Space Library Authority</em></dt>
<dd>*EXECUTE</dd>
<dt><em>Resource Authority</em></dt>
<dd>*USE</dd>
<dt><em>Library Authority</em></dt>
<dd>*USE</dd>
<dt><em>User Space Lock</em></dt>
<dd>*EXCLRD</dd>
<dt><em>Resource Lock</em></dt>
<dd>*SHRRD</dd>
</dl>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Qualified user space name</strong></dt>
<dd>INPUT; CHAR(20)
<p>The user space that the copy of the AFPDS resource is inserted into. The
first 10 characters contain the user space name and the second 10 characters
contain the library name.</p>
<p>You can use these special values for the library name:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td valign="top"><em>*CURLIB</em></td>
<td valign="top">The job's current library</td>
</tr>
<tr>
<td valign="top"><em>*LIBL</em></td>
<td valign="top">The library list</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Format name</strong></dt>
<dd>INPUT; CHAR(8)
<p>The format and content of the information returned in the user space.</p>
<p>You must specify the following:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td valign="top"><em>CPYR0100</em></td>
<td valign="top">Information about the resources, and the resource AFPDS data
stream.</td>
</tr>
<tr>
<td valign="top"></td>
<td valign="top">For more information about the CPYR0100 format, see <a href=
"#FIGCPYR100">Format CPYR0100</a>.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Qualified resource name</strong></dt>
<dd>INPUT; CHAR(20)
<p>The name of the AFPDS resource to be copied. The first 10 characters contain
the resource name and the second 10 characters contain the library name. The
user must specify the library name.</p>
<p>The following special values can be used for the library name:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td valign="top"><em>*CURLIB</em></td>
<td valign="top">The job's current library.</td>
</tr>
<tr>
<td valign="top"><em>*LIBL</em></td>
<td valign="top">The library list.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Resource object type</strong></dt>
<dd>INPUT; CHAR(10)
<p>The object type of the AFPDS resource.</p>
<p>The following values are allowed:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td valign="top"><em>*PAGSEG</em></td>
<td valign="top">Page segment</td>
</tr>
<tr>
<td valign="top"><em>*PAGDFN</em></td>
<td valign="top">Page definition</td>
</tr>
<tr>
<td valign="top"><em>*OVL</em></td>
<td valign="top">Overlay</td>
</tr>
<tr>
<td valign="top"><em>*FORMDF</em></td>
<td valign="top">Form definition</td>
</tr>
<tr>
<td valign="top"><em>*FNTRSC</em></td>
<td valign="top">Font resource</td>
</tr>
</table>
<br>
</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="HDRCPYRSUS">Format of the User Space</a></h3>
<p>The format of the user space consists of:</p>
<ul>
<li>A user area</li>
<li>A generic header</li>
<li>An input parameter section</li>
<li>A header section</li>
<li>A resource information section</li>
<li>A resource data stream section</li>
</ul>
<p>For details about the user area and generic header fields, see <a href=
"../apiref/usf.htm">User Space Format for List APIs</a>. The organization of the user
space after the header section is dependent on format CPYR0100.</p>
<p><a href="#FIGCPYR100">Format CPYR0100</a> shows the general structure of the
user space for format CPYR0100.</p>
<p>Offset values are calculated from the beginning of the user space.</p>
<p><strong><a name="FIGCPYR100">Format CPYR0100</a></strong> <img src=
"RBAFX567.gif" alt="Format CPYR100"></p>
<br>
<br>
<h3><a name="HDRCPYRIP1">Input Parameter Section</a></h3>
<p>For more details about the fields, see <a href="#HDRCPYRHD1">Field
Descriptions</a>.</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%">User space name specified</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">User space library name specified</td>
</tr>
<tr>
<td align="center" valign="top">20</td>
<td align="center" valign="top">14</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">Format name specified</td>
</tr>
<tr>
<td align="center" valign="top">28</td>
<td align="center" valign="top">1C</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Resource name specified</td>
</tr>
<tr>
<td align="center" valign="top">38</td>
<td align="center" valign="top">26</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Resource library name specified</td>
</tr>
<tr>
<td align="center" valign="top">48</td>
<td align="center" valign="top">30</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Resource object type specified</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRCPYRHD1">Field Descriptions</a></h3>
<p><strong>Format name specified.</strong> The format of the user space
specified.</p>
<p><strong>Resource library name specified.</strong> The name of the library
name of the AFPDS resource specified.</p>
<p><strong>Resource name specified.</strong> The name of the AFPDS resource
specified.</p>
<p><strong>Resource object type specified.</strong> The object type of the
AFPDS resource specified.</p>
<p><strong>User space library name specified.</strong> The library name of the
user space specified.</p>
<p><strong>User space name specified.</strong> The name of the user space
specified.</p>
<br>
<h3>Header Section</h3>
<p>The following table shows the header information returned for the CPYR0100
format.</p>
<p>For more details about the fields, see <a href="#HDRCPYRHDE">Field
Descriptions</a>.</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%">User space name used</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">User space library name used</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">Resource object name used</td>
</tr>
<tr>
<td align="center" valign="top">30</td>
<td align="center" valign="top">1E</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Resource object library used</td>
</tr>
<tr>
<td align="center" valign="top">40</td>
<td align="center" valign="top">28</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Resource object type used</td>
</tr>
<tr>
<td align="center" valign="top">50</td>
<td align="center" valign="top">32</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">52</td>
<td align="center" valign="top">34</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to resource information</td>
</tr>
<tr>
<td align="center" valign="top">56</td>
<td align="center" valign="top">38</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Size of resource information</td>
</tr>
<tr>
<td align="center" valign="top">60</td>
<td align="center" valign="top">3C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to resource data stream</td>
</tr>
<tr>
<td align="center" valign="top">64</td>
<td align="center" valign="top">40</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Size of resource data stream</td>
</tr>
</table>
<br>
<h3><a name="HDRCPYRHDE">Field Descriptions</a></h3>
<p><strong>Offset to resource data stream.</strong> Locates the data for the
resource data stream returned. The offset value is calculated from the
beginning of the user space.</p>
<p><strong>Offset to resource information.</strong> Locates the data for the
resource information returned. The offset value is calculated from the
beginning of the user space. This value is zero when the resource object type
requested is not *FNTRSC.</p>
<p><strong>Reserved.</strong> Reserved for byte alignment.</p>
<p><strong>Resource object library name used.</strong> The name of the library
of the AFPDS resource used to retrieve the resource.</p>
<p><strong>Resource object name used.</strong> The name of the AFPDS resource
used to retrieve the resource.</p>
<p><strong>Resource object type used.</strong> The object type of the AFPDS
resource used to retrieve the resource.</p>
<p><strong>Size of resource data stream.</strong> The size, in bytes, of the
resource data stream section.</p>
<p><strong>Size of resource information.</strong> The size, in bytes, of the
resource information section. This value is zero when the requested resource
object type is not *FNTRSC.</p>
<p><strong>User space library name used.</strong> The library name of the user
space used.</p>
<p><strong>User space name used.</strong> The name of the user space used.<br>
<br>
</p>
<h3>Resource Information Section</h3>
<p>For more details about the fields, see <a href="#HDRCPYRHD2">Field
Descriptions</a>.</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(1)</td>
<td align="left" valign="top" width="60%">Pel density</td>
</tr>
<tr>
<td align="center" valign="top">1</td>
<td align="center" valign="top">1</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Font resource subtype</td>
</tr>
</table>
<br>
<h3><a name="HDRCPYRHD2">Field Descriptions</a></h3>
<p><strong>Font resource subtype.</strong> The type of font resource returned
in the user space.</p>
<p>Valid values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td valign="top"><em>FNTCHRSET</em></td>
<td valign="top">Font character set</td>
</tr>
<tr>
<td valign="top"><em>CDEPAG</em></td>
<td valign="top">Code page</td>
</tr>
<tr>
<td valign="top"><em>CDEFNT</em></td>
<td valign="top">Coded font</td>
</tr>
</table>
<br>
<p><strong>Pel density.</strong> The pel density of the font resource returned
in the user space.</p>
<p>Valid values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td valign="top"><em>0</em></td>
<td valign="top">Undefined</td>
</tr>
<tr>
<td valign="top"><em>1</em></td>
<td valign="top">240 pel density</td>
</tr>
<tr>
<td valign="top"><em>2</em></td>
<td valign="top">300 pel density</td>
</tr>
<tr>
<td valign="top"><em>3</em></td>
<td valign="top">Adobe Type 1 outline font.</td>
</tr>
<tr>
<td valign="top"><em>4</em></td>
<td valign="top">Adobe Type 0 composite outline font.</td>
</tr>
<tr>
<td valign="top"><em>5</em></td>
<td valign="top">600 pel density</td>
</tr>
</table>
<br>
<h3>Resource Data Stream Section</h3>
<p>The resource data stream section contains the AFPDS data stream of the
resource that is to be copied.</p>
<br>
<h3>Error Messages</h3>
<table 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 valign="top">CPF2150 E</td>
<td valign="top">Object information function failed.</td>
</tr>
<tr>
<td valign="top">CPF2151 E</td>
<td valign="top">Operation failed for &amp;2 in &amp;1 type *&amp;3.</td>
</tr>
<tr>
<td valign="top">CPF24B4 E</td>
<td valign="top">Severe error while addressing parameter list.</td>
</tr>
<tr>
<td valign="top">CPF3CF1 E</td>
<td valign="top">Error code parameter not valid.</td>
</tr>
<tr>
<td valign="top">CPF3C21 E</td>
<td valign="top">Format name &amp;1 is not valid.</td>
</tr>
<tr>
<td valign="top">CPF33CF E</td>
<td valign="top">Qualified resource name not valid.</td>
</tr>
<tr>
<td valign="top">CPF34CE E</td>
<td valign="top">Value &amp;1 not valid for resource object type.</td>
</tr>
<tr>
<td valign="top">CPF34C5 E</td>
<td valign="top">The AFPDS resource is too large for the user space
&amp;1.</td>
</tr>
<tr>
<td valign="top">CPF811A E</td>
<td valign="top">User space &amp;4 in &amp;9 damaged.</td>
</tr>
<tr>
<td valign="top">CPF9801 E</td>
<td valign="top">Object &amp;2 in library &amp;3 not found.</td>
</tr>
<tr>
<td valign="top">CPF9802 E</td>
<td valign="top">Not authorized to object &amp;2 in &amp;3.</td>
</tr>
<tr>
<td valign="top">CPF9803 E</td>
<td valign="top">Cannot allocate object &amp;2 in library &amp;3.</td>
</tr>
<tr>
<td valign="top">CPF9807 E</td>
<td valign="top">One or more libraries in library list deleted.</td>
</tr>
<tr>
<td valign="top">CPF9808 E</td>
<td valign="top">Cannot allocate one or more libraries on library list.</td>
</tr>
<tr>
<td valign="top">CPF9810 E</td>
<td valign="top">Library &amp;1 not found.</td>
</tr>
<tr>
<td valign="top">CPF9820 E</td>
<td valign="top">Not authorized to use library &amp;1.</td>
</tr>
<tr>
<td valign="top">CPF9830 E</td>
<td valign="top">Cannot assign library &amp;1.</td>
</tr>
<tr>
<td valign="top">CPF9838 E</td>
<td valign="top">User profile storage limit exceeded.</td>
</tr>
<tr>
<td valign="top">CPF9872 E</td>
<td valign="top">Program or service program &amp;1 in library &amp;2 ended.
Reason code &amp;3.</td>
</tr>
</table>
<br>
<hr>
API introduced: V3R7
<hr>
<center>
<table cellpadding="2" cellspacing="2">
<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>
</center>
</body>
</html>