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

294 lines
7.4 KiB
HTML

<!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>Change Resource Entry Information (QRZCHGE) 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. -->
<!-- GSA ADP Schedule Contract with IBM Corp. -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!-- This file has undergone html cleanup on 1/14/02 by JET -->
<!-- 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 type="text/javascript" language="Javascript" src="../rzahg/synch.js">
</script>
<h2>Change Resource Entry Information (QRZCHGE) API</h2>
<div class="box" style="width: 80%;">
<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="40%">Resource variable</td>
<td align="left" valign="top" width="25%">Input</td>
<td align="left" valign="top" width="25%">Char(*)</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">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: *EXCLUDE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Change Resource Entry Information (QRZCHGE) API changes resource
information and maps one resource onto another.</p>
<br>
<h3>Authorities and Locks</h3>
<dl>
<dt><em>API Public Authority</em></dt>
<dd>*EXCLUDE</dd>
</dl>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Resource variable</strong></dt>
<dd>INPUT; CHAR(*)
<p> The structure that specifies which resource information is to be changed
and what the resource information is to be changed to.</p>
</dd>
<dt><strong>Format name</strong></dt>
<dd>INPUT; CHAR(8)
<p> The content and format of the resource information and resource change
variables. The possible format names are as follows:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>CHGE0100</em></td>
<td align="left" valign="top">A resource name is to be changed. See <a href=
"#HDRCHGE100">CHGE0100 Format</a> for details of this format.</td>
</tr>
<tr>
<td align="left" valign="top"><em>CHGE0200</em></td>
<td align="left" valign="top">A resource that is to be mapped. See <a href=
"#HDRCHGE200">CHGE0200 Format</a> for details of this format.</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="HDRCHGE100">CHGE0100 Format</a></h3>
<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(32)</td>
<td align="left" valign="top" width="60%">Resource name</td>
</tr>
<tr>
<td align="center" valign="top">32</td>
<td align="center" valign="top">20</td>
<td align="left" valign="top">CHAR(32)</td>
<td align="left" valign="top">Resource name change</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRCHGEFD">Field Descriptions</a></h3>
<p><strong>Resource name.</strong> The resource name to be changed. The
resource name must comply with the following rules:</p>
<ul>
<li>Be up to and including 10 characters in length</li>
<li>Begin with one of the following characters: A-Z, 0-9, $, #, or @</li>
<li>Can use, after the first character, any combination of A-Z, 0-9, $, @, #,
period (.), and underscore (_) for the remaining characters</li>
</ul>
This name is left-justified and padded with trailing blanks.
<p><strong>Resource name change.</strong> The value that the resource name is
to be changed to. This name is left-justified and padded with trailing
blanks.</p>
<br>
<h3><a name="HDRCHGE200">CHGE0200 Format</a></h3>
<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(32)</td>
<td align="left" valign="top" width="60%">Resource name</td>
</tr>
<tr>
<td align="center" valign="top">32</td>
<td align="center" valign="top">20</td>
<td align="left" valign="top">CHAR(32)</td>
<td align="left" valign="top">Resource name</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRCHGFDT">Field Descriptions</a></h3>
<p><strong>Resource name.</strong> The name of the resource that is to have its
resource information exchanged with another resource.</p>
<br>
<h3>Error Messages</h3>
<table width="100%" cellpadding="5">
<!-- cols="15 85" -->
<tr>
<th align="left" valign="top" nowrap>Message ID</th>
<th align="left" valign="top">Error Message Text</th>
</tr>
<tr>
<td align="left" valign="top">CPF0B3B E</td>
<td align="left" valign="top">Resource name not found.</td>
</tr>
<tr>
<td align="left" valign="top">CPF0B38 E</td>
<td align="left" valign="top">Resource information not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF0B46 E</td>
<td align="left" valign="top">Materialize failed.</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">CPF3CF1 E</td>
<td align="left" valign="top">Error code parameter not valid.</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">CPF3C90 E</td>
<td align="left" valign="top">Literal value cannot be changed.</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>
</table>
<br>
<hr>
API introduced: V3R6
<hr>
<table align="center" cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center">
<a href="#Top_Of_Page">Top</a> |
<a href="config.htm">Configuration APIs</a> |
<a href="aplist.htm">API by category</a></td>
</tr>
</table>
</body>
</html>