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

1233 lines
37 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>Retrieve Backup History (QEZRTBKH) 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 cleanup completed Jan 2002 by v2cdijab -->
<!-- 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>Retrieve Backup History (QEZRTBKH) API</h2>
<div class="box" style="width: 80%;">
&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">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">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 Retrieve Backup History (QEZRTBKH) API retrieves information about the
backup status and history into a single variable in the calling program. The
amount of information that is returned depends on the size of the variable. The
information that this API returns is the same information that the Display
Backup Status (DSPBCKSTS) command returns.</p>
<br>
<h3>Authorities and Locks</h3>
<dl>
<dt><em>User Index Authority</em></dt>
<dd>*USE</dd>
<dt><em>User Index 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 receiver variable that receives the information requested. You can
specify the size of the area to be smaller than the format requested as long as
you specify the length parameter correctly. As a result, the API returns only
the data that the area can hold.</p>
</dd>
<dt><strong>Length of receiver variable</strong></dt>
<dd>INPUT; BINARY(4)
<p>The length of the receiver variable provided. The length of receiver
variable parameter may be specified up to the size of the receiver variable
specified in the user program. If the length of receiver variable parameter
specified is larger than the allocated size of the receiver variable specified
in the user program, the results are not predictable. The minimum length is 8
bytes.</p>
</dd>
<dt><strong>Format name</strong></dt>
<dd>INPUT; CHAR(8)
<p>The format of the command information to be returned. One of the following
format names may be used:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>RBKH0100</em></td>
<td align="left" valign="top">Basic backup status and history. For more
information, see <a href="#HDRRBKH100">RBKH0100 Format</a>.</td>
</tr>
<tr>
<td align="left" valign="top"><em>RBKH0200</em></td>
<td align="left" valign="top">Detailed backup status and information. For more
information, see <a href="#HDRRBKH200">RBKH0200 Format</a>.</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="HDRRBKH100">RBKH0100 Format</a></h3>
<p> The following table describes the information that is returned in the
receiver variable for the RBKH0100 format. For detailed descriptions of the
fields, see <a href="#HDRERCMDD">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%">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">CHAR(7)</td>
<td align="left" valign="top">Last date all user libraries backed up</td>
</tr>
<tr>
<td align="center" valign="top">15</td>
<td align="center" valign="top">F</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Last backup time of all user libraries</td>
</tr>
<tr>
<td align="center" valign="top">21</td>
<td align="center" valign="top">15</td>
<td align="left" valign="top">CHAR(4)</td>
<td align="left" valign="top">Tape set for all user libraries</td>
</tr>
<tr>
<td align="center" valign="top">25</td>
<td align="center" valign="top">19</td>
<td align="left" valign="top">CHAR(7)</td>
<td align="left" valign="top">Last date all user libraries backed up (changes
only)</td>
</tr>
<tr>
<td align="center" valign="top">32</td>
<td align="center" valign="top">20</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Last backup time of all user libraries (changes
only)</td>
</tr>
<tr>
<td align="center" valign="top">38</td>
<td align="center" valign="top">26</td>
<td align="left" valign="top">CHAR(4)</td>
<td align="left" valign="top">Tape set for all user libraries (changes
only)</td>
</tr>
<tr>
<td align="center" valign="top">42</td>
<td align="center" valign="top">2A</td>
<td align="left" valign="top">CHAR(7)</td>
<td align="left" valign="top">Last date libraries on list backed up</td>
</tr>
<tr>
<td align="center" valign="top">49</td>
<td align="center" valign="top">31</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Last backup time of libraries on list</td>
</tr>
<tr>
<td align="center" valign="top">55</td>
<td align="center" valign="top">37</td>
<td align="left" valign="top">CHAR(4)</td>
<td align="left" valign="top">Tape set for libraries on list</td>
</tr>
<tr>
<td align="center" valign="top">59</td>
<td align="center" valign="top">3B</td>
<td align="left" valign="top">CHAR(7)</td>
<td align="left" valign="top">Last date libraries on list backed up (changes
only)</td>
</tr>
<tr>
<td align="center" valign="top">66</td>
<td align="center" valign="top">42</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Last backup time of libraries on list (changes
only)</td>
</tr>
<tr>
<td align="center" valign="top">72</td>
<td align="center" valign="top">48</td>
<td align="left" valign="top">CHAR(4)</td>
<td align="left" valign="top">Tape set for libraries on list (changes
only)</td>
</tr>
<tr>
<td align="center" valign="top">76</td>
<td align="center" valign="top">4C</td>
<td align="left" valign="top">CHAR(7)</td>
<td align="left" valign="top">Last date all folders backed up</td>
</tr>
<tr>
<td align="center" valign="top">83</td>
<td align="center" valign="top">53</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Last backup time of all folders</td>
</tr>
<tr>
<td align="center" valign="top">89</td>
<td align="center" valign="top">59</td>
<td align="left" valign="top">CHAR(4)</td>
<td align="left" valign="top">Tape set for folders</td>
</tr>
<tr>
<td align="center" valign="top">93</td>
<td align="center" valign="top">5D</td>
<td align="left" valign="top">CHAR(7)</td>
<td align="left" valign="top">Last date all folders backed up (changes
only)</td>
</tr>
<tr>
<td align="center" valign="top">100</td>
<td align="center" valign="top">64</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Last backup time of all folders (changes
only)</td>
</tr>
<tr>
<td align="center" valign="top">106</td>
<td align="center" valign="top">6A</td>
<td align="left" valign="top">CHAR(4)</td>
<td align="left" valign="top">Tape set for folders (changes only)</td>
</tr>
<tr>
<td align="center" valign="top">110</td>
<td align="center" valign="top">6E</td>
<td align="left" valign="top">CHAR(7)</td>
<td align="left" valign="top">Last date folders on list backed up</td>
</tr>
<tr>
<td align="center" valign="top">117</td>
<td align="center" valign="top">75</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Last backup time of folders on list</td>
</tr>
<tr>
<td align="center" valign="top">123</td>
<td align="center" valign="top">7B</td>
<td align="left" valign="top">CHAR(4)</td>
<td align="left" valign="top">Tape set for folders on list</td>
</tr>
<tr>
<td align="center" valign="top">127</td>
<td align="center" valign="top">7F</td>
<td align="left" valign="top">CHAR(7)</td>
<td align="left" valign="top">Last date security data backed up</td>
</tr>
<tr>
<td align="center" valign="top">134</td>
<td align="center" valign="top">86</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Last backup time of security data</td>
</tr>
<tr>
<td align="center" valign="top">140</td>
<td align="center" valign="top">8C</td>
<td align="left" valign="top">CHAR(4)</td>
<td align="left" valign="top">Tape set for security data</td>
</tr>
<tr>
<td align="center" valign="top">144</td>
<td align="center" valign="top">90</td>
<td align="left" valign="top">CHAR(7)</td>
<td align="left" valign="top">Last date configuration data backed up</td>
</tr>
<tr>
<td align="center" valign="top">151</td>
<td align="center" valign="top">97</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Last backup time of configuration</td>
</tr>
<tr>
<td align="center" valign="top">157</td>
<td align="center" valign="top">9D</td>
<td align="left" valign="top">CHAR(4)</td>
<td align="left" valign="top">Tape set for configuration data</td>
</tr>
<tr>
<td align="center" valign="top">161</td>
<td align="center" valign="top">A1</td>
<td align="left" valign="top">CHAR(7)</td>
<td align="left" valign="top">Last date calendars backed up</td>
</tr>
<tr>
<td align="center" valign="top">168</td>
<td align="center" valign="top">A8</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Last backup time of calendars</td>
</tr>
<tr>
<td align="center" valign="top">174</td>
<td align="center" valign="top">AE</td>
<td align="left" valign="top">CHAR(4)</td>
<td align="left" valign="top">Tape set for calendars</td>
</tr>
<tr>
<td align="center" valign="top">178</td>
<td align="center" valign="top">B2</td>
<td align="left" valign="top">CHAR(7)</td>
<td align="left" valign="top">Last date mail backed up</td>
</tr>
<tr>
<td align="center" valign="top">185</td>
<td align="center" valign="top">B9</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Last backup time of mail</td>
</tr>
<tr>
<td align="center" valign="top">191</td>
<td align="center" valign="top">BF</td>
<td align="left" valign="top">CHAR(4)</td>
<td align="left" valign="top">Tape set for mail</td>
</tr>
<tr>
<td align="center" valign="top">195</td>
<td align="center" valign="top">C3</td>
<td align="left" valign="top">CHAR(7)</td>
<td align="left" valign="top">Last date all user directories backed up</td>
</tr>
<tr>
<td align="center" valign="top">202</td>
<td align="center" valign="top">CA</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Last backup time of all user directories</td>
</tr>
<tr>
<td align="center" valign="top">208</td>
<td align="center" valign="top">D0</td>
<td align="left" valign="top">CHAR(4)</td>
<td align="left" valign="top">Tape set for all user directories backed up</td>
</tr>
<tr>
<td align="center" valign="top">212</td>
<td align="center" valign="top">D4</td>
<td align="left" valign="top">CHAR(7)</td>
<td align="left" valign="top">Last date all user directories backed up (changes
only)</td>
</tr>
<tr>
<td align="center" valign="top">219</td>
<td align="center" valign="top">DB</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Last backup time of all user directories (changes
only)</td>
</tr>
<tr>
<td align="center" valign="top">225</td>
<td align="center" valign="top">E1</td>
<td align="left" valign="top">CHAR(4)</td>
<td align="left" valign="top">Tape set for all user directories backed up
(changes only)</td>
</tr>
<tr>
<td align="center" valign="top">229</td>
<td align="center" valign="top">E5</td>
<td align="left" valign="top">CHAR(21)</td>
<td align="left" valign="top">Reserved</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRRBKH200">RBKH0200 Format</a></h3>
<p> The following table describes the information that is returned in the
receiver variable for the RBKH0200 format. For detailed descriptions of the
fields, see <a href="#HDRERCMDD">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%"></td>
<td align="left" valign="top" width="60%">Returns everything from format
RBKH0100</td>
</tr>
<tr>
<td align="center" valign="top">250</td>
<td align="center" valign="top">FA</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Number of backup date entries</td>
</tr>
<tr>
<td align="center" valign="top">254</td>
<td align="center" valign="top">FE</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of a backup date entry</td>
</tr>
<tr>
<td align="left" valign="top" colspan="4"><strong>Note:</strong> Format of a
backup date entry. The backup date entry fields repeat, in the order listed, by
the number of backup date entries. The decimal and hexadecimal offsets to the
following fields depend on the number of backup date entries and the length of
a backup date entry.</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(7)</td>
<td align="left" valign="top">Backup date</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Backup time</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Backup options</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(4)</td>
<td align="left" valign="top">Tape set</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Changes only</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">User libraries saved</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Folders saved</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">User directories saved</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Security data saved</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Configuration saved</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Calendars saved</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Mail saved</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRERCMDD">Field Descriptions</a></h3>
<p>Some of the fields use a date format (CYYMMDD) as follows:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>C</em></td>
<td align="left" valign="top">Century, where 0 indicates years 19<em>xx</em> and
1 indicates years 20<em>xx</em>.</td>
</tr>
<tr>
<td align="left" valign="top"><em>YY</em></td>
<td align="left" valign="top">Year</td>
</tr>
<tr>
<td align="left" valign="top"><em>MM</em></td>
<td align="left" valign="top">Month</td>
</tr>
<tr>
<td align="left" valign="top"><em>DD</em></td>
<td align="left" valign="top">Day</td>
</tr>
</table>
<p>Some of the fields use a time format (HHMMSS), where:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>HH</em></td>
<td align="left" valign="top">Hour</td>
</tr>
<tr>
<td align="left" valign="top"><em>MM</em></td>
<td align="left" valign="top">Minute</td>
</tr>
<tr>
<td align="left" valign="top"><em>SS</em></td>
<td align="left" valign="top">Second</td>
</tr>
</table>
<p>For more information on the following fields, refer to the documentation for
the Display Backup Status (DSPBCKSTS) command in the <a href=
"../rbam6/rbam6clmain.htm">Control Language (CL)</a> information.</p>
<p><strong>Backup date.</strong> The completion date of the backup. This date
is in the format CYYMMDD.</p>
<p><strong>Backup time.</strong> The completion time of the backup. This time
is in the format HHMMSS.</p>
<p><strong>Backup options.</strong> The backup option that were used. The
possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*DAILY</em></td>
<td align="left" valign="top"></td>
</tr>
<tr>
<td align="left" valign="top"><em>*WEEKLY</em></td>
<td align="left" valign="top"></td>
</tr>
<tr>
<td align="left" valign="top"><em>*MONTHLY</em></td>
<td align="left" valign="top"></td>
</tr>
</table>
<p><strong>Bytes available.</strong> The number of bytes of data available to
be returned. All available data is returned if enough space is provided.</p>
<p><strong>Bytes returned.</strong> The number of bytes of data returned.</p>
<p><strong>Calendars saved.</strong> Whether OfficeVision calendars were saved
during the backup.</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">No OfficeVision calendars were saved during the
backup.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">All OfficeVision calendars were saved during the
backup.</td>
</tr>
</table>
<p><strong>Changes only.</strong> Whether the backup saved only the changes to
libraries, directories, and folders.</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">All objects in the libraries, folders, and
directories were saved during the backup.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Only changes made to the libraries, folders, and
directories since the last backup were saved during the backup.</td>
</tr>
</table>
<p><strong>Configuration saved.</strong> Whether the system configuration was
saved.</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The system configuration was not saved during the
backup.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The system configuration was saved during the
backup.</td>
</tr>
</table>
<p><strong>Folders saved.</strong> Which folders were saved during the backup.
The possible values follow:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Only folders that were selected from the folder
backup list were saved.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">All folders were saved.</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">No folders were saved.</td>
</tr>
</table>
<p><strong>Last backup time of calendars.</strong> The completion time of the
most recent backup of all the calendars for OfficeVision. This time uses the
24-hour clock and is in the format HHMMSS.</p>
<p><strong>Last backup time of mail.</strong> The completion time of the most
recent backup of all the mail for OfficeVision. This time uses the 24-hour
clock and is in the format HHMMSS.</p>
<p><strong>Last backup time of all folders.</strong> The completion time of the
most recent backup of all the objects in all the root folders. This time uses
the 24-hour clock and is in the format HHMMSS.</p>
<p><strong>Last backup time of all folders (changes only).</strong> The
completion time of the most recent backup of all the objects in all the root
folders that changed since the previous backup. This time uses the 24-hour
clock and is in the format HHMMSS.</p>
<p><strong>Last backup time of all user directories.</strong> The completion
time of the most recent backup of all the objects in all the user directories
on the system. This time uses the 24-hour clock and is in the format
HHMMSS.</p>
<p><strong>Last backup time of all user directories (changes only).</strong>
The completion time of the most recent backup of all the objects in all the
user directories that changed since the previous backup. This time uses the
24-hour clock and is in the format HHMMSS.</p>
<p><strong>Last backup time of all user libraries.</strong> The completion time
of the most recent backup of all the objects in all the user libraries on the
system. This time uses the 24-hour clock and is in the format HHMMSS.</p>
<p><strong>Last backup time of all user libraries (changes only).</strong> The
completion time of the most recent backup of all the objects in all the user
libraries that changed since the previous backup. This time uses the 24-hour
clock and is in the format HHMMSS.</p>
<p><strong>Last backup time of configuration.</strong> The completion time of
the most recent backup of the system configuration. This uses the 24-hour clock
and is in the format HHMMSS.</p>
<p><strong>Last backup time of folders on list.</strong> The completion time of
the most recent backup of all the objects in all the folders on the folder
backup list. This time uses the 24-hour clock and is in the format HHMMSS.</p>
<p><strong>Last backup time of libraries on list.</strong> The completion time
of the most recent backup of all the objects in all the libraries on the
library backup list. This time uses the 24-hour clock and is in the format
HHMMSS.</p>
<p><strong>Last backup time of libraries on list (changes only).</strong> The
completion time of the most recent backup of all the objects in all the
libraries on the library backup list that changed since the previous backup.
This time uses the 24-hour clock and is in the format HHMMSS.</p>
<p><strong>Last backup time of security data.</strong> The completion time of
the most recent backup of all the system security data. This uses the 24-hour
clock and is in the format HHMMSS.</p>
<p><strong>Last date all folders backed up.</strong> The completion date for
the most recent backup of all the objects in all the root folders on the
system. This date is in the format CYYMMDD.</p>
<p><strong>Last date all folders backed up (changes only).</strong> The
completion date for the most recent backup of all the objects in all the
folders that changed since the previous backup. This date is in the format
CYYMMDD.</p>
<p><strong>Last date all user directories backed up (changes only).</strong>
The completion date for the most recent backup of all the objects in all the
user directories that changed since the previous backup. This date is in the
format CYYMMDD.</p>
<p><strong>Last date all user directories backed up.</strong> The completion
date for the most recent backup of all the objects in all the user directories
on the system. This date is in the format CYYMMDD.</p>
<p><strong>Last date all user libraries backed up.</strong> The completion date
for the most recent backup of all the objects in all the user libraries on the
system. This date is in the format CYYMMDD.</p>
<p><strong>Last date all user libraries backed up (changes only).</strong> The
completion date for the most recent backup of all the objects in all the user
libraries that changed since the previous backup. This date is in the format
CYYMMDD.</p>
<p><strong>Last date calendars backed up.</strong> The completion date for the
most recent backup of all the OfficeVision calendars on the system. This date
is in the format CYYMMDD.</p>
<p><strong>Last date configuration data backed up.</strong> The last backup
date for the most recent backup of the system configuration.</p>
<p><strong>Last date folders on list backed up.</strong> The completion date
for the most recent backup of all the objects in all the folders in the folder
backup list. This date is in the format CYYMMDD.</p>
<p><strong>Last date libraries on list backed up.</strong> The completion date
for the most recent backup of all the objects in all the libraries in the
library backup list. This date is in the format CYYMMDD.</p>
<p><strong>Last date libraries on list backed up (changes only).</strong> The
completion date for the most recent backup of all the objects in all the
libraries in the library backup list that changed since the previous backup.
This date is in the format CYYMMDD.</p>
<p><strong>Last date mail backed up.</strong> The completion date for the most
recent backup of all the OfficeVision mail on the system. This date is in the
format CYYMMDD.</p>
<p><strong>Last date security data backed up.</strong> The last backup date for
the most recent backup of system security data.</p>
<p><strong>Length of a backup date entry.</strong> The length of one backup
date entry.</p>
<p><strong>Mail saved.</strong> Whether mail was saved during the backup.</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">OfficeVision mail was not saved during the
backup.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">OfficeVision mail was saved during the
backup.</td>
</tr>
</table>
<p><strong>Number of backup date entries.</strong> The number of backup date e
ntries that are contained in format RBKH0200.</p>
<p><strong>Reserved.</strong> This space is reserved for future use.</p>
<p><strong>Security data saved.</strong> Whether the security data was
saved.</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Security data was not saved during the
backup.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Security data was saved during the backup.</td>
</tr>
</table>
<p><strong>Tape set.</strong> The name of the last tape set that the system
used to complete the backup of the information described in this backup date
entry.</p>
<p><strong>Tape set for all user directories backed up.</strong> The name of
the last tape set that the system used for the most recent backup of all the
objects in all the user directories on the system. The possible value
follows:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ANY</em></td>
<td align="left" valign="top">The option that the system used for the backup
did not specify a tape set name.</td>
</tr>
</table>
<p><strong>Tape set for all user directories backed up (changes only).</strong>
The name of the last tape set that the system used for the most recent backup
of all the objects in all the user directories that changed since the previous
backup. The possible value follows:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ANY</em></td>
<td align="left" valign="top">The option that the system used for the backup
did not specify a tape set name.</td>
</tr>
</table>
<p><strong>Tape set for all user libraries.</strong> The name of the last tape
set that the system used for the most recent backup of all the objects in all
the user libraries on the system. The possible value follows:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ANY</em></td>
<td align="left" valign="top">The option that the system used for the backup
did not specify a tape set name.</td>
</tr>
</table>
<p><strong>Tape set for all user libraries (changes only).</strong> The name of
the last tape set that the system used for the most recent backup of all the
objects in all the user libraries that changed since the previous backup. The
possible value follows:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ANY</em></td>
<td align="left" valign="top">The option that the system used for the backup
did not specify a tape set name.</td>
</tr>
</table>
<p><strong>Tape set for calendars.</strong> The name of the last tape set that
the system used for the most recent backup of all the calendars for
OfficeVision.</p>
<p>The possible value follows:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ANY</em></td>
<td align="left" valign="top">The option that the system used for the backup
did not specify a tape set name.</td>
</tr>
</table>
<p><strong>Tape set for configuration.</strong> The name of the last tape set
that the system used for the most recent backup of the system configuration.
The possible value follows:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ANY</em></td>
<td align="left" valign="top">The option that the system used for the backup
did not specify a tape set name.</td>
</tr>
</table>
<p><strong>Tape set for folders.</strong> The name of the last tape set that
the system used for the most recent backup of all the objects in all the root
folders on the system. The possible value follows:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ANY</em></td>
<td align="left" valign="top">The option that the system used for the backup
did not specify a tape set name.</td>
</tr>
</table>
<p><strong>Tape set for folders (changes only).</strong> The name of the last
tape set that the system used for the most recent backup of all the new and
changed documents from all the new and changed root folders since the previous
backup. The possible value follows:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ANY</em></td>
<td align="left" valign="top">The option that the system used for the backup
did not specify a tape set name.</td>
</tr>
</table>
<p><strong>Tape set for folders on list.</strong> The name of the last tape se
t that the system used for the most recent backup of all the folders that were
selected for backup from the folder backup list. The possible value
follows:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ANY</em></td>
<td align="left" valign="top">The option that the system used for the backup
did not specify a tape set name.</td>
</tr>
</table>
<p><strong>Tape set for libraries on list.</strong> The name of the last tape
set that the system used for the most recent backup of all the libraries on the
library backup list. The possible value follows:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ANY</em></td>
<td align="left" valign="top">The option that the system used for the backup
did not specify a tape set name.</td>
</tr>
</table>
<p><strong>Tape set for libraries on list (changes only).</strong> The name of
the last tape set that the system used for the most recent backup of all the
objects in the libraries on the library backup list that changed since the
previous backup. The possible value follows:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ANY</em></td>
<td align="left" valign="top">The option that the system used for the backup
did not specify a tape set name.</td>
</tr>
</table>
<p><strong>Tape set for mail.</strong> The name of the last tape set that the
system used for the most recent backup of all the mail for OfficeVision. The
possible value follows:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ANY</em></td>
<td align="left" valign="top">The option that the system used for the backup
did not specify a tape set name.</td>
</tr>
</table>
<p><strong>Tape set for security data.</strong> The name of the last tape set
that the system used for the most recent backup of the system security data.
The possible value follows:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ANY</em></td>
<td align="left" valign="top">The option that the system used for the backup
did not specify a tape set name.</td>
</tr>
</table>
<p><strong>User directories saved.</strong> The directories that were saved
during the backup. The possible values follow:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">All user directories were saved.</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">No user directories were saved.</td>
</tr>
</table>
<p><strong>User libraries saved.</strong> The libraries that were saved during
the backup. The possible values follow:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Only user libraries that were selected from the
library backup list were saved.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">All user libraries were saved.</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">No user libraries were saved.</td>
</tr>
</table>
<br>
<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" width="15%">CPF1E00 E</td>
<td align="left" valign="top" width="85%">All CPF1Exx messages could be
returned. xx is from 01 to FF.</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">CPF3C19 E</td>
<td align="left" valign="top">Error occurred with receiver variable
specified.</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">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: 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=
"back1.htm">Backup and Recovery APIs</a> | <a href="aplist.htm">APIs by
category</a></td>
</tr>
</table>
</center>
</body>
</html>