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

517 lines
14 KiB
HTML
Raw 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>Change Object Backup List (QEZCHBKL) 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>Change Object Backup List (QEZCHBKL) API</h2>
<div class="box" style="width: 60%;">
&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%">Input structure</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">Char(*)</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">Input structure length</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">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 Change Object Backup List (QEZCHBKL) API changes the backup type for a
list of objects that are specified by the user.</p>
<br>
<h3>Authorities and Locks</h3>
<dl>
<dt><em>User Index Authority</em></dt>
<dd>*CHANGE</dd>
<dt><em>User Index Lock</em></dt>
<dd>*SHRRD</dd>
</dl>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Input structure</strong></dt>
<dd>INPUT; CHAR(*)
<p>This structure includes the keys and data that are needed to make the
necessary changes to the backup definitions.</p>
</dd>
<dt><strong>Input structure length</strong></dt>
<dd>INPUT; BINARY(4)
<p>The length of the input structure. A minimum length of 16 is required.</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="HDREZFVLR">Format for Variable Length Records</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%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Number of variable length
records</td>
</tr>
<tr>
<td align="left" valign="TOP" colspan="2" rowspan="4">These fields repeat for
each variable length record.</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of variable length record</td>
</tr>
<tr>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Key</td>
</tr>
<tr>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of data</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Data</td>
</tr>
</table>
<p>If the length of the data is longer than the key field's data length, the
data is truncated at the right. No message is issued.</p>
<p>If the length of the data is smaller than the key field's data length, the
data is padded with blanks at the right. No message is issued.</p>
<p>It is not an error to specify a key more than once. If duplicate keys are
specified, the last specified value for that key is used.</p>
<p>Each variable length record must be 4-byte aligned. If not, unpredictable
results may occur.</p>
<br>
<h3>Field Descriptions</h3>
<strong>Number of variable length records</strong>. The number of records. Only
specific attributes can be changed. Refer to <a href="#HDRVLDK">Valid Keys</a>
for more information.
<p><strong>Length of variable length record</strong>. The length of each
record. Only specific attributes can be changed. Refer to <a href="#HDRVLDK">
Valid Keys</a> for more information.</p>
<p><strong>Key</strong>. The key specifies either the library or folder
attribute. For the list of valid keys, see <a href="#HDRVLDK">Valid
Keys</a>.</p>
<p><strong>Length of data</strong>. The length of the data that is used to
specify the value for the given parameter.</p>
<p><strong>Data</strong>. The data that is used to specify the value for the
given key.</p>
<br>
<h3><a name="HDRVLDK">Valid Keys</a></h3>
<p>The following table lists the valid keys for the key field area of the
variable length record. For detailed descriptions of the keys, see Field
Descriptions.</p>
<table border width="60%">
<tr>
<th align="center" valign="top">Key</th>
<th align="left" valign="top">Type</th>
<th align="left" valign="top">Field</th>
</tr>
<tr>
<td align="center" valign="top" width="20%">1</td>
<td align="left" valign="top" width="30%">CHAR(*)</td>
<td align="left" valign="top" width="50%">Library</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Folder</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRCBKDKD">Field Descriptions</a></h3>
<p><strong>Folder.</strong> The backup type selected and the list of folder
objects to have their backup type changed. For the format of this field, see <a
href="#HDRCBKDFK">Folder Key Format</a>.</p>
<p><strong>Library.</strong> The backup type selected and the list of library
objects to have their backup type changed. For the format of this field, see <a
href="#HDRCBKDLK">Library Key Format</a>.</p>
<br>
<h3><a name="HDRCBKDFK">Folder Key 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%">&nbsp;</td>
<td align="center" valign="top" width="10%">&nbsp;</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Number in array</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">Backup type</td>
</tr>
<tr>
<td align="left" valign="top" colspan="4"><strong>Note:</strong> This field
repeats for each folder name.</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(12)</td>
<td align="left" valign="top">Folder name</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRCBKDFD">Field Descriptions</a></h3>
<p><strong>Folder name.</strong> The folder name of the object to be changed
for the backup type that you specified.</p>
<p><strong>Number in array.</strong> The number of folder names of objects to
have their backup type changed. The value must be 1 or greater.</p>
<p><strong>Backup type.</strong> The backup type that you selected for the
folder objects. 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">Back up daily. Back up folder objects during the
daily backup. Backing up daily means that the folder objects are also saved on
the weekly and monthly backups.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">Back up weekly. Back up folder objects during the
weekly backup. Backing up weekly means that the folder objects are also saved
on the monthly backups.</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">Back up monthly. Back up folder objects during
the monthly backup.</td>
</tr>
<tr>
<td align="left" valign="top"><em>4</em></td>
<td align="left" valign="top">No backup. Folder objects are not backed up at
all.</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRCBKDLK">Library Key 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%">&nbsp;</td>
<td align="center" valign="top" width="10%">&nbsp;</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Number in array</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">Backup type</td>
</tr>
<tr>
<td align="left" valign="top" colspan="4"><strong>Note:</strong> This field
repeats for each library name.</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">Library name</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRCBKDLD">Field Descriptions</a></h3>
<p><strong>Library name.</strong> The library name of the object to be changed
for the backup type that you specified.</p>
<p><strong>Number in array.</strong> The number of library names of objects to
have their backup type changed. The value must be 1 or greater.</p>
<p><strong>Backup type.</strong> Backup type that you selected for the library
objects. 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">Back up daily. Back up library objects during the
daily backup. Backing up daily means that the library objects are also saved on
the weekly and monthly backups.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">Back up weekly. Backup library objects during the
weekly backup. Backing up weekly means that the library objects are also saved
on the monthly backups.</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">Back up monthly. Back up library objects during
the monthly backup.</td>
</tr>
<tr>
<td align="left" valign="top"><em>4</em></td>
<td align="left" valign="top">No backup. Library objects are not backed up at
all.</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%">CPF1E65 E</td>
<td align="left" valign="top" width="85%">Library backup list in use.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1E6B E</td>
<td align="left" valign="top">Folder backup list in use.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1EC5 E</td>
<td align="left" valign="top">Backup option &amp;1 is not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1EEA E</td>
<td align="left" valign="top">Not authorized to library backup list.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1EEB E</td>
<td align="left" valign="top">Not authorized to folder backup list.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1E99 E</td>
<td align="left" valign="top">Unexpected error occurred.</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">CPF3C81 E</td>
<td align="left" valign="top">Value for key &amp;1 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">CPF3CF1 E</td>
<td align="left" valign="top">Error code parameter not valid.</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>
</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>
Reference in New Issue View Git Blame Copy Permalink