868 lines
24 KiB
HTML
868 lines
24 KiB
HTML
<!--ArborText, Inc., 1988-2002, v.4002-->
|
|
<!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>Restore from Application (QaneRsta) 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. -->
|
|
<!-- BACKMST SCRIPT A converted by B2H R4.1 (346) (CMS) by v2kea304 at -->
|
|
<!-- RCHVMW2 on 26 April 1999 at 10:21:58 -->
|
|
<!-- Change History: -->
|
|
<!-- YYMMDD USERID Change description -->
|
|
<!-- File tagging validation completed Jan 2002 by v2cdijab -->
|
|
<!-- End Header Records -->
|
|
<link href="../rzahg/ic.css" type="text/css" rel="stylesheet">
|
|
</head>
|
|
<body>
|
|
<a name="Top_Of_Page"></a> <!-- Java sync-link -->
|
|
|
|
<script type="text/javascript" language="Javascript" src="../rzahg/synch.js">
|
|
</script>
|
|
|
|
<h2>Restore from Application (QaneRsta) API</h2>
|
|
|
|
<div class="box" style="width: 80%;"><br>
|
|
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">User space 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">Status 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">4</td>
|
|
<td align="left" valign="top">Status information</td>
|
|
<td align="left" valign="top">Output</td>
|
|
<td align="left" valign="top">Char(*)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">5</td>
|
|
<td align="left" valign="top">Length of status information</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">6</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>
|
|
Service Program Name: QANESERV<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Default Public Authority: *USE<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Threadsafe: No<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
</div>
|
|
|
|
<p>The Restore from Application (QaneRsta) API enables an application to
|
|
provide the restore records that are required for a restore-from-save-file
|
|
operation. The application defines the restore operation by specifying the type
|
|
of restore command, and by providing the restore command parameters. The API
|
|
calls an exit program to retrieve the restore records from the application
|
|
instead of from the save file.</p>
|
|
|
|
<p>To use the API, the application must provide the following:</p>
|
|
|
|
<ul>
|
|
<li>A user space that contains the required input parameter group</li>
|
|
|
|
<li>An exit program</li>
|
|
</ul>
|
|
|
|
<p>When processing the restore command, the API does the following:</p>
|
|
|
|
<ul>
|
|
<li>Calls the exit program to indicate the start of the transfer sequence</li>
|
|
|
|
<li>Submits the restore command for processing</li>
|
|
|
|
<li>Calls the exit program repeatedly to transfer the restore records</li>
|
|
|
|
<li>Calls the exit program to signal the end of the restore operation</li>
|
|
|
|
<li>May call the exit program to force an abnormal end to the restore
|
|
operation</li>
|
|
</ul>
|
|
|
|
<p>The program that calls the API is suspended while the restore operation is
|
|
being processed.</p>
|
|
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Restrictions</h3>
|
|
|
|
<p>QTEMP should not be specified for the library name on the OUTFILE parameter
|
|
because the restore command is submitted by a prestart job running in the
|
|
QSYSWRK subsystem and not in the job that called the API. Locks should not be
|
|
applied to restore objects that would conflict with locks applied by the
|
|
restore operation running in the prestart job.</p>
|
|
|
|
<p>Objects can be restored by this API only if the objects were saved using the
|
|
<a href="QaneSava.htm">Save to Application</a> (QaneSava) API, and only if the
|
|
objects were saved from the current or an earlier release of the operating
|
|
system.</p>
|
|
|
|
<p>The application must provide the restore records in the order presented,
|
|
without modification, for the objects to be successfully restored.</p>
|
|
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Authorities and Locks</h3>
|
|
|
|
<dl>
|
|
<dt><em>Exit Program Library Authority</em></dt>
|
|
|
|
<dd>*EXECUTE
|
|
<br>
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><em>Exit Program Authority</em></dt>
|
|
|
|
<dd>*EXECUTE
|
|
<br>
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><em>User Space Lock</em></dt>
|
|
|
|
<dd>*SHRNUP
|
|
<br>
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><em>User Space Library Authority</em></dt>
|
|
|
|
<dd>*USE
|
|
<br>
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><em>User Space Authority</em></dt>
|
|
|
|
<dd>*USE
|
|
<br>
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><em>Restore Command Library Authority</em></dt>
|
|
|
|
<dd>*EXECUTE
|
|
<br>
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><em>Restore Command Authorities</em></dt>
|
|
|
|
<dd>See the restore command
|
|
<br>
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><em>Restored Object Locks</em></dt>
|
|
|
|
<dd>See the <a href="../rzaiu/rzaiuintro.htm" target="_blank">Back up your
|
|
server</a> topic.
|
|
<br>
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><em>Restored Object Authorities</em></dt>
|
|
|
|
<dd>See Appendix D in the <a href="../books/sc415302.pdf" target="_blank">
|
|
iSeries Security Reference</a><img src="wbpdf.gif" alt="Link to PDF">
|
|
book.</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 contains all the control information for the restore
|
|
operation. The first 10 characters contain the user space name. The second 10
|
|
characters contain the name of the library where the user space is located.</p>
|
|
|
|
<p>You can use the following special values for the library name:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tbody>
|
|
<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 user space. 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 actual library that is used is returned in
|
|
the status information. the user space.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
The library list is used to locate the user space.
|
|
<br>
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>User space format name</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(8)
|
|
|
|
<p>The format name for the input parameters that are contained in the user
|
|
space. For the format of the structure, see <a href="#HDRRSTA100">SVRS0100
|
|
Format</a>.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Status format name</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(8)
|
|
|
|
<p>The format name for the status information returned on the API call. For the
|
|
format of the structure, see <a href="#HDRRSST100">SRST0100 Format</a>.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Status information</strong></dt>
|
|
|
|
<dd>OUTPUT; CHAR(*)
|
|
|
|
<p>The status information returned on the API call.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Length of status information</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The length of the status information returned on the API call. The minimum
|
|
length is 8 bytes.</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="HDRRSTA100">SVRS0100 Format</a></h3>
|
|
|
|
<p>This format defines the input parameter group for the API.</p>
|
|
|
|
<table width="80%" frame="border">
|
|
<tbody>
|
|
<tr>
|
|
<th colspan="2" align="center" valign="bottom">Offset</th>
|
|
<th rowspan="2" align="left" valign="bottom">Type</th>
|
|
<th rowspan="2" align="left" valign="bottom">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%">Length of structure</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Offset to restore command parameters</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">8</td>
|
|
<td align="center" valign="top">8</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Length of restore command parameters</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">12</td>
|
|
<td align="center" valign="top">C</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Offset to application data</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">Length of application data</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">Restore command type</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">Exit program name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">34</td>
|
|
<td align="center" valign="top">22</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Exit program library</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">44</td>
|
|
<td align="center" valign="top">2C</td>
|
|
<td align="left" valign="top">CHAR(8)</td>
|
|
<td align="left" valign="top">Target release</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top"> </td>
|
|
<td align="center" valign="top"> </td>
|
|
<td align="left" valign="top">CHAR(*)</td>
|
|
<td align="left" valign="top">Restore command parameters</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top"> </td>
|
|
<td align="center" valign="top"> </td>
|
|
<td align="left" valign="top">CHAR(*)</td>
|
|
<td align="left" valign="top">Application data</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<br>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Field Descriptions</h3>
|
|
|
|
<p><strong>Application data.</strong> Information that the application wants
|
|
passed to the exit program. The content of this information is defined by the
|
|
application. This field could contain information specific to the object being
|
|
saved (such as the object name, size, and so forth), or it could contain the
|
|
qualified name of another object that contains this information.</p>
|
|
|
|
<p><strong>Exit program library.</strong> The name of the library that contains
|
|
the exit program called by the API. the exit program.</p>
|
|
|
|
<p><strong>Exit program name.</strong> The name of the exit program that is
|
|
called by the API. See <a href="XANERSTA.htm">Restore from Application</a> exit
|
|
program for additional details.</p>
|
|
|
|
<p><strong>Length of application data.</strong> The length of the application
|
|
data. This value is passed to the exit program. This value must be set to zero
|
|
if there is no application data.</p>
|
|
|
|
<p><strong>Length of restore command parameters.</strong> The length of the
|
|
restore command parameters. The maximum allowable length is 32500 bytes for
|
|
restore commands.</p>
|
|
|
|
<p><strong>Length of structure.</strong> The length of this structure, from the
|
|
start of the input parameters to the last byte of the application data.</p>
|
|
|
|
<p><strong>Offset to application data.</strong> The byte offset from the
|
|
beginning of the user space to the start of the application data. This value
|
|
must be set to zero if there is no application data.</p>
|
|
|
|
<p><strong>Offset to restore command parameters.</strong> The byte offset from
|
|
the beginning of the user space to the start of the restore command
|
|
parameters.</p>
|
|
|
|
<p><img src="delta.gif" alt="Start of change"><strong>Restore command
|
|
parameters.</strong> A character string that contains the restore command
|
|
parameters or restore keys. These parameters are validated when the API submits
|
|
the command for processing. Refer to the restore commands in the <a href=
|
|
"../rbam6/rbam6clmain.htm">Control Language (CL)</a> for detailed information
|
|
about valid parameters. Refer to the <a href="qsrrestore.htm">Restore
|
|
Object</a> (QsrRestore) API or <a href="qsrrsto.htm">Restore Object List</a>
|
|
(QSRRSTO) API for detailed information about valid keys.<img src=
|
|
"deltaend.gif" alt="End of change"></p>
|
|
|
|
<p>These additional restrictions apply to the restore command parameters when
|
|
you use this API:</p>
|
|
|
|
<ul>
|
|
<li>The parameters must be consistent with the restore command type.</li>
|
|
|
|
<li>The parameters must not include the restore command name.</li>
|
|
|
|
<li>The parameters must be separated by at least one blank character.</li>
|
|
|
|
<li><img src="delta.gif" alt="Start of change">The Device (DEV) and Save
|
|
file (SAVF) parameters must not be used. These parameters are provided by the
|
|
API.<img src="deltaend.gif" alt="End of change"></li>
|
|
|
|
<li><img src="delta.gif" alt="Start of change">The End of media option
|
|
(ENDOPT), Label (LABEL), Media definition (MEDDFN), Optical file (OPTFILE),
|
|
Sequence number (SEQNBR) and Volume identifier (VOL) parameters must not be
|
|
used. These parameters are inconsistent with the save file operation provided
|
|
by the API.<img src="deltaend.gif" alt="End of change"></li>
|
|
|
|
<li>Only single library names can be used with the SAVLIB or RSTLIB
|
|
parameter.</li>
|
|
</ul>
|
|
|
|
<p>The following examples illustrate the restore command parameters that are
|
|
required for typical restore scenarios:</p>
|
|
|
|
<ul>
|
|
<li>Example 1: Restore command type 1 (RST)
|
|
|
|
<pre>
|
|
OBJ('/*') ('/QSYS.LIB' *OMIT)
|
|
('/QDLS.LIB' *OMIT)
|
|
</pre>
|
|
|
|
<p>These parameters restore all objects that are not in libraries and that are
|
|
not document library objects.</p>
|
|
</li>
|
|
|
|
<li>Example 2: Restore command type 2 (RSTOBJ)
|
|
|
|
<pre>
|
|
OBJ(FILE*) SAVLIB(MYLIB) OBJTYPE(*FILE)
|
|
SAVDATE(122297) RSTLIB(TMPLIB)
|
|
</pre>
|
|
|
|
<p>These parameters restore all files with names that start with the characters
|
|
FILE* to library TMPLIB that were saved from the library named MYLIB on 22
|
|
December 1997.</p>
|
|
</li>
|
|
|
|
<li>Example 3: Restore command type 4 (RSTLIB)
|
|
|
|
<pre>
|
|
SAVLIB(JOE)
|
|
</pre>
|
|
|
|
<p>These parameters restore the library named JOE.</p>
|
|
</li>
|
|
</ul>
|
|
|
|
<p><img src="delta.gif" alt="Start of change">These additional restrictions
|
|
apply to the command parameters when you use the Restore Object (QsrRestore)
|
|
API or Restore Object List (QSRRSTO) API.<img src="deltaend.gif" alt=
|
|
"End of change"></p>
|
|
|
|
<ul>
|
|
<li>The keys specified must be consistent with restore from save file
|
|
operations.</li>
|
|
|
|
<li><img src="delta.gif" alt="Start of change">The Device (DEV) and Save
|
|
file (SAVF) keys must not be used. These keys are provided by this API.<img
|
|
src="deltaend.gif" alt="End of change"></li>
|
|
|
|
<li><img src="delta.gif" alt="Start of change">The End of media option
|
|
(ENDOPT), Label (LABEL), Media definition (MEDDFN), Optical file (OPTFILE),
|
|
Sequence number (SEQNBR) and Volume identifier (VOL) keys must not be used.
|
|
These keys are inconsistent with the save file operation provided by the
|
|
API.<img src="deltaend.gif" alt="End of change"></li>
|
|
|
|
<li>The starting offset for the keys is always 0 and not the offset of the
|
|
restore command parameters.</li>
|
|
|
|
<li>All integer values within the keys must be aligned on 4-byte
|
|
boundaries.</li>
|
|
|
|
<li>All pointers within the keys must be aligned on 16-byte boundaries.</li>
|
|
</ul>
|
|
|
|
<p><strong>Restore command type.</strong> The type of restore command that is
|
|
to be processed.</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">Restore (RST) command</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>2</em></td>
|
|
<td align="left" valign="top">Restore Object (RSTOBJ) command</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>3</em></td>
|
|
<td align="left" valign="top">Restore Document Library Object (RSTDLO)
|
|
command</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>4</em></td>
|
|
<td align="left" valign="top">Restore Library (RSTLIB) command</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>5</em></td>
|
|
<td align="left" valign="top">Restore Object (QsrRestore) API</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><img src="delta.gif" alt="Start of change"><em>6</em></td>
|
|
<td valign="top">Restore Object List (QSRRSTO) API</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>7</em></td>
|
|
<td valign="top">Restore System Information (RSTSYSINF) command<img src=
|
|
"deltaend.gif" alt="End of change"></td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Target release.</strong></p>
|
|
|
|
<p>An ignored field. Must be set to blanks.</p>
|
|
|
|
|
|
<br>
|
|
|
|
|
|
<h3><a name="HDRRSST100">SRST0100 Format</a></h3>
|
|
|
|
<p>This format defines the status information that is returned on the API
|
|
call.</p>
|
|
|
|
<table width="80%" frame="border">
|
|
<tbody>
|
|
<tr>
|
|
<th colspan="2" align="center" valign="bottom">Offset</th>
|
|
<th rowspan="2" align="left" valign="bottom">Type</th>
|
|
<th rowspan="2" align="left" valign="bottom">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%">Bytes returned</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Bytes available</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">8</td>
|
|
<td align="center" valign="top">8</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Transfer time</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">12</td>
|
|
<td align="center" valign="top">C</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Transfer block size</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">Transfer block multiplier</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">Last block size</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">User space library used</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top"><img src="delta.gif" alt="Start of change">
|
|
34</td>
|
|
<td align="center" valign="top">22</td>
|
|
<td valign="top">CHAR(2)</td>
|
|
<td valign="top">Reserved<img src="deltaend.gif" alt="End of change"></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top"><img src="delta.gif" alt="Start of change">
|
|
36</td>
|
|
<td align="center" valign="top">24</td>
|
|
<td valign="top">BINARY(4)</td>
|
|
<td valign="top">Decimal transfer time<img src="deltaend.gif" alt=
|
|
"End of change"></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<br>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Field Descriptions</h3>
|
|
|
|
<p><strong>Bytes returned.</strong> The number of status information bytes
|
|
returned. If the value specified in the length of status information parameter
|
|
is larger than the specified status information structure, this value is set to
|
|
the last byte of the returned information.</p>
|
|
|
|
<p><strong>Bytes available.</strong> The number of status information bytes
|
|
available for the specified status information format.</p>
|
|
|
|
<p><img src="delta.gif" alt="Start of change"><strong>Decimal transfer
|
|
time.</strong>The decimal portion of the transfer time in millionths of a
|
|
second. If the value returned for Transfer time was 5 and the value returned
|
|
for Decimal transfer time was 827352, then the total transfer time was 5.827352
|
|
seconds.<img src="deltaend.gif" alt="End of change"></p>
|
|
|
|
<p><img src="delta.gif" alt="Start of change">
|
|
<strong>Reserved.</strong>This field is unused and will be returned with
|
|
blanks.<img src="deltaend.gif" alt="End of change"></p>
|
|
|
|
<p><strong>Transfer block size.</strong> The number of bytes in the blocks
|
|
transferred by the exit program.</p>
|
|
|
|
<p><strong>Transfer block multiplier.</strong> The number of blocks
|
|
successfully transferred by the exit program.</p>
|
|
|
|
<p><strong>Last block size.</strong> The number of bytes in the last block
|
|
transferred by the exit program.</p>
|
|
|
|
<p>The true transfer size of the operation is equal to the transfer block size
|
|
multiplied by the transfer block multiplier plus the last block size.</p>
|
|
|
|
<p><strong>Transfer time.</strong> The elapsed time, in seconds, that begins
|
|
when the application calls the API, and ends when the API returns to the
|
|
caller.</p>
|
|
|
|
<p><strong>User space library used.</strong> The name of the user space library
|
|
that is used in the API call.</p>
|
|
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Error Messages</h3>
|
|
|
|
<table width="100%" cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tbody>
|
|
<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" width="15%">CPF3700 E</td>
|
|
<td align="left" valign="top" width="85%">All CPF37xx messages could be
|
|
signalled. xx is from 01 to FF, excluding tape and diskette errors since the
|
|
operation is a restore from a save file.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3800 E</td>
|
|
<td align="left" valign="top">All CPF38xx messages could be signalled. xx is
|
|
from 01 to FF, excluding tape and diskette errors since the operation is a
|
|
restore from a save file.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF2115 E</td>
|
|
<td align="left" valign="top">Object &1 in &2 type *&3
|
|
damaged.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C1E E</td>
|
|
<td align="left" valign="top">Required parameter &1 omitted.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C21 E</td>
|
|
<td align="left" valign="top">Format name &1 is 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">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">CPF9800 E</td>
|
|
<td align="left" valign="top">All CPF98xx messages could be signaled. xx is
|
|
from 01 to FF.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9999 E</td>
|
|
<td align="left" valign="top">Function check. &1 unmonitored by &2 at
|
|
statement &5, instruction &3.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFB8C0 E</td>
|
|
<td align="left" valign="top">Status information length for &1 API is not
|
|
valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFB8C1 E</td>
|
|
<td align="left" valign="top">Unsupported value for &1 API.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFB8C2 E</td>
|
|
<td align="left" valign="top">Offset value for &1 API not valid. Reason
|
|
&6.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFB8C3 E</td>
|
|
<td align="left" valign="top">Length value for &1 API not valid. Reason
|
|
&6.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFB8C4 E</td>
|
|
<td align="left" valign="top">Unexpected condition with exit program for &1
|
|
API. Reason &6.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFB8C5 E</td>
|
|
<td align="left" valign="top">Parameter &2 specified more than once for API
|
|
&1.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPIB8C6 I</td>
|
|
<td align="left" valign="top">Trace data generated for API &1.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFB8C7 E</td>
|
|
<td align="left" valign="top">Unsupported value for &1 API.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFB8C8 E</td>
|
|
<td align="left" valign="top">Command syntax error detected by &1 API.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFB8C9 E</td>
|
|
<td align="left" valign="top">Command exception occurred using &1 API.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFB8CF E</td>
|
|
<td align="left" valign="top">Unexpected condition with &1 API. Reason
|
|
&6.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<br>
|
|
|
|
|
|
<hr>
|
|
API introduced: V4R3
|
|
|
|
<hr>
|
|
<center>
|
|
<table cellspacing="2" cellpadding="2">
|
|
<tbody>
|
|
<tr align="center">
|
|
<td align="center" valign="middle"><a href="#Top_Of_Page">Top</a> | <a href=
|
|
"back1.htm">Backup and Recovery APIs</a> | <a href="aplist.htm">APIs by
|
|
category</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</center>
|
|
</body>
|
|
</html>
|
|
|