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

2523 lines
77 KiB
HTML
Raw Normal View History

Add readme and dist folders
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>Save Object (QsrSave) 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. -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!-- BACKMST SCRIPT A converted by B2H R4.1 (346) (CMS) by v2kea304 at -->
<!-- RCHVMW2 on 26 April 1999 at 10:21:58 -->
<!-- 020601 JSIMON v5r3 XPF D99092 OBJFTR -->
<!-- 020804 THOMP v5r3 XPF D98689 SCAN -->
<!-- 020929 JSIMON v5r3 XPF D99092 Change OBJFTR to PATTERN -->
<!-- 030418 DRH v5r3 UHLP P9A28560 See CL help text updates -->
<!-- 040803 THOMP v5r4 XPF D99833 parallel tape support -->
<!-- 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>Save Object (QsrSave) 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%">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">Error code</td>
<td align="left" valign="top">I/O</td>
<td align="left" valign="top">Char(*)</td>
</tr>
</table>
<br>
&nbsp;&nbsp;Service Program Name: QSRLIB01<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Save Object (QsrSave) API saves a copy of one or more objects that can
be used in the integrated file system.</p>
<p>For detailed restrictions on
using this API to save objects in libraries or to save document library
objects, see <a href="../rzaiu/rzaiurzaiu148.htm">Save file systems</a>
in the Backup and recovery topic.</p>
<br>
<h3>Authorities and Locks</h3>
<dl>
<dt><strong><em>User Space</em></strong></dt>
<dd>
<dl>
<dt><em>User Space Authority</em></dt>
<dd>*USE</dd>
<dt><em>User Space Library Authority</em></dt>
<dd>*EXECUTE</dd>
<dt><em>User Space Lock</em></dt>
<dd>*EXCLRD</dd>
</dl>
<br>
</dd>
<dt><strong><em>Objects to Be Saved, Devices, Save While Active,
Save-While-Active Message Queue, and Output</em></strong></dt>
<dd>
<dl>
<dt><em>Locking</em></dt>
<dd>See <a href="../rzaiu/rzaiurzaiu319.htm">Object locking rules</a> in the Backup
and recovery topic for
information on object locking for the Save Object (SAV) command.</dd>
<dt><em>Authority</em></dt>
<dd>In the <a href="../books/sc415302.pdf" target="_blank">iSeries Security Reference</a>
<img src="wbpdf.gif" alt="Link to PDF"> book, see the Appendix about
authorities required for the Save Object (SAV) command.</dd>
</dl>
</dd>
</dl>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Qualified user space name</strong></dt>
<dd>INPUT; CHAR(20)</dd>
<dd>The user space that is to hold all the information for the save 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. See
<a href="#HDRUSRSPC2">User Space Format</a> for the format of the information in the
user space.
<p>You can use the following special values for the library name. However, it
should be noted that the library name that is actually used is not passed back
to the user. Care should be taken when you use these special values to avoid
unexpected results.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<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 library list is used to locate the user
space.</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="HDRUSRSPC2">User Space Format</a></h3>
<p>The following defines the format for the information in the user space. For
detailed descriptions of the fields in the user space format, see
<a href="#HDRUSFDS2">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%">Number of variable length
records</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 first record</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="center" valign="top">8</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="left" valign="top" colspan="4"><strong>Note:</strong> These fields
repeat for each variable length record.</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Key</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to next record</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<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 identifier's data length,
the data will be truncated at the right. No message will be issued.</p>
<p>If the specified data length is shorter than the key field's defined data
length, an error message is returned for binary fields. If the field is a
character field, the data is padded with blanks and an error message will not
be returned.</p>
<p><strong>Note:</strong> This does not apply to keys that allow a list of
values to be specified. In these cases, the amount of data read is based on the
specified number of entries in the list.</p>
<p>If keys are duplicated in the user space, only the last value for a given
key is used for the save operation.</p>
<p>Each variable length record must be 4-byte aligned. If not, unpredictable
results may occur.</p>
<br>
<h3><a name="HDRUSFDS2">Field Descriptions</a></h3>
<p><strong>Data.</strong> The data used to specify the value for the given
key.</p>
<p><strong>Key.</strong> The parameter of the Save Object (SAV) command to
specify. See <a href="#HDRKEYFLD2">Valid Keys</a> for the list of valid
keys.</p>
<p><strong>Offset to first record.</strong> The offset from the beginning of
the user space to the first variable length record.</p>
<p><strong>Offset to next record.</strong> The offset from the beginning of the
user space to the next variable length record.</p>
<p><strong>Number of variable length records.</strong> The number of variable
length records that are passed in the user space. The valid range is from 2 through 25.</p>
<p><em>Reserved.</em> Reserved. The possible value is:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>x'00'</em></td>
<td align="left" valign="top">This field should contain x'00's.</td>
</tr>
</table>
<br>
<h3><a name="HDRKEYFLD2">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 the
<a href="#HDRSOLDES2">Field Descriptions</a>.</p>
<p>Some messages for this API refer to parameters and values of the Save Object
(SAV) command. This table can also be used to locate the key names that
correspond to the SAV command parameters. The field descriptions contain, in
addition to detailed descriptions, the corresponding parameter values.</p>
<p>The object path name key and the device path name key are required keys. The
other keys are optional.</p>
<table border width="80%">
<tr>
<th align="center" valign="bottom">Key</th>
<th align="left" valign="bottom">Type</th>
<th align="left" valign="bottom">Field</th>
<th align="left" valign="bottom">SAV Command<br>
Parameter</th>
</tr>
<tr>
<td align="center" valign="top" width="10%">1</td>
<td align="left" valign="top" width="20%">CHAR(*)</td>
<td align="left" valign="top" width="35%">Device path name</td>
<td align="left" valign="top" width="35%">DEV</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Object path name</td>
<td align="left" valign="top">OBJ</td>
</tr>
<tr>
<td align="center" valign="top">3</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Directory subtree</td>
<td align="left" valign="top">SUBTREE</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">System</td>
<td align="left" valign="top">SYSTEM</td>
</tr>
<tr>
<td align="center" valign="top">5</td>
<td align="left" valign="top">CHAR(40)</td>
<td align="left" valign="top">Change period</td>
<td align="left" valign="top">CHGPERIOD</td>
</tr>
<tr>
<td align="center" valign="top">6</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Object precheck</td>
<td align="left" valign="top">PRECHK</td>
</tr>
<tr>
<td align="center" valign="top">7</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Target release</td>
<td align="left" valign="top">TGTRLS</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Update history</td>
<td align="left" valign="top">UPDHST</td>
</tr>
<tr>
<td align="center" valign="top">9</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Volume identifier</td>
<td align="left" valign="top">VOL</td>
</tr>
<tr>
<td align="center" valign="top">10</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Label</td>
<td align="left" valign="top">LABEL</td>
</tr>
<tr>
<td align="center" valign="top">11</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Sequence number</td>
<td align="left" valign="top">SEQNBR</td>
</tr>
<tr>
<td align="center" valign="top">12</td>
<td align="left" valign="top">CHAR(7)</td>
<td align="left" valign="top">Expiration date</td>
<td align="left" valign="top">EXPDATE</td>
</tr>
<tr>
<td align="center" valign="top">13</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">End of media option</td>
<td align="left" valign="top">ENDOPT</td>
</tr>
<tr>
<td align="center" valign="top">14</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Clear</td>
<td align="left" valign="top">CLEAR</td>
</tr>
<tr>
<td align="center" valign="top">15</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Data compression</td>
<td align="left" valign="top">DTACPR</td>
</tr>
<tr>
<td align="center" valign="top">16</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Data compaction</td>
<td align="left" valign="top">COMPACT</td>
</tr>
<tr>
<td align="center" valign="top">17</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Optical file</td>
<td align="left" valign="top">OPTFILE</td>
</tr>
<tr>
<td align="center" valign="top">18</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Save while active</td>
<td align="left" valign="top">SAVACT</td>
</tr>
<tr>
<td align="center" valign="top">19</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Save-while-active message queue</td>
<td align="left" valign="top">SAVACTMSGQ</td>
</tr>
<tr>
<td align="center" valign="top">20</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Output</td>
<td align="left" valign="top">OUTPUT, INFTYPE</td>
</tr>
<tr>
<td align="center" valign="top">21</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Use optimum block size</td>
<td align="left" valign="top">USEOPTBLK</td>
</tr>
<tr>
<td align="center" valign="top">22</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Save-while-active option</td>
<td align="left" valign="top">SAVACTOPT</td>
</tr>
<tr>
<td align="center" valign="top">23</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">ASP device name</td>
<td align="left" valign="top">ASPDEV</td>
</tr>
<tr>
<td align="center" valign="top">24</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Name pattern</td>
<td align="left" valign="top">PATTERN</td>
</tr>
<tr>
<td align="center" valign="top">25</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Scan objects</td>
<td align="left" valign="top">SCAN</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRSOLDES2">Field Descriptions</a></h3>
<p>The values shown in parentheses are the corresponding values for the SAV
command parameters.</p>
<p><strong>ASP device name.</strong> The names of the auxiliary storage pool
(ASP) devices to be included in the save operation. The default is *ALLAVL. The
possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ALLAVL</em></td>
<td align="left" valign="top">The operation includes the system ASP (ASP number
1), all basic user ASPs (ASP numbers 2-32), and all available independent
ASPs.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*</em></td>
<td align="left" valign="top">The operation includes the system ASP, all basic
user ASPs, and, if the job has a linked ASP group, all independent ASPs in the
linked ASP group.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*SYSBAS</em></td>
<td align="left" valign="top">The operation includes the system ASP and all
basic user ASPs.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*ASPGRP</em></td>
<td align="left" valign="top">If the job has a linked ASP group, all
independent ASPs in the linked ASP group are included in the save
operation.</td>
</tr>
<tr>
<td align="left" valign="top" nowrap><em>ASP device name</em></td>
<td align="left" valign="top">The operation includes the specified independent
ASP.</td>
</tr>
</table>
<p><strong>Change period.</strong> A date and time range. Objects that changed
within the range are saved.</p>
<p>If this key is not specified, the default of *ALL will be used for the start
date and time and the end date and time.</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%">&nbsp;</td>
<td align="center" valign="top" width="10%">&nbsp;</td>
<td align="left" valign="top" width="20%">CHAR(10)</td>
<td align="left" valign="top" width="60%">Start date</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">Start 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">End date</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">End time</td>
</tr>
</table>
<p><em>End date.</em> The date before which objects that have changed are
saved. The possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">No ending date is specified. All objects changed
since the starting date are saved.</td>
</tr>
<tr>
<td align="left" valign="top"><em>end-date</em></td>
<td align="left" valign="top">The date before which objects that have changed
are saved in the format CYYMMDD:
<table cellpadding="5">
<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>
</td>
</tr>
</table>
<p><em>End time.</em> The time on the end date before which objects that have
changed are saved. The possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">All times of day are included in the range.</td>
</tr>
<tr>
<td align="left" valign="top"><em>end-time</em></td>
<td align="left" valign="top">The time on the end date before which objects
that have changed are saved in the format HHMMSS:
<table cellpadding="5">
<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>
<tr>
<td align="left" valign="top" colspan="2"><strong>Note:</strong> An explicit
time is valid only if the ending date is an explicit date.</td>
<td align="left" valign="top"></td>
</tr>
</table>
</td>
</tr>
</table>
<p><em>Start date.</em> The date after which objects that have changed are
saved. The possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">No starting date is specified. All objects
changed prior to the ending date are saved.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*LASTSAVE</em></td>
<td align="left" valign="top">Objects are saved that have changed since the
last time they were saved with update history.
<p><strong>Notes:</strong></p>
<ol>
<li>If this value is specified, the value *ALL must be specified on all other
elements of this key.</li>
<li>For file systems that are accessed through the network server, the PC
archive attribute is used. For other file systems, the system archive attribute
is used.</li>
</ol>
</td>
</tr>
<tr>
<td align="left" valign="top"><em>start-date</em></td>
<td align="left" valign="top">The date after which objects that have changed
are saved in the format CYYMMDD:
<table cellpadding="5">
<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>
</td>
</tr>
</table>
<p><em>Start time.</em> The time on the start date after which objects that
have changed are saved. The possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">All times of day are included in the range.</td>
</tr>
<tr>
<td align="left" valign="top"><em>start-time</em></td>
<td align="left" valign="top">The time on the start date after which objects
that have changed are saved in the format HHMMSS:
<table cellpadding="5">
<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>
<tr>
<td align="left" valign="top" colspan="2"><strong>Note:</strong> An explicit
time is valid only if the starting date is an explicit date.</td>
</tr>
</table>
</td>
</tr>
</table>
<p><strong>Clear.</strong> Whether active data on the media is cleared or
replaced automatically. Active data is any file on the media that has not
expired. Clearing active data removes all files from the volume, starting at
the specified sequence number for the tape. Replacing active data on optical
media replaces only the optical files created by this operation. The default is
0.</p>
<p><strong>Notes:</strong></p>
<ol type="a">
<li>Clearing a tape does not initialize it. Before the save command is issued,
you should initialize the tape to a standard label format by using the
Initialize Tape (INZTAP) command and specifying a value on the NEWVOL
parameter.</li>
<li>Clearing an optical volume does initialize it.</li>
<li>If a volume that is not initialized is encountered during the save
operation, an inquiry message is sent and an operator can initialize the
volume.</li>
</ol>
<p>The possible values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">None of the media is cleared automatically. If
the save operation encounters active data on a tape or save
file, an inquiry message is sent, allowing the operator to either end the save
operation or clear the media. If the save operation encounters the specified
optical file, an inquiry message is sent, allowing the operator to either end
the save operation or replace the file. (*NONE)</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">All of the media is cleared automatically. (*ALL)
<p>If tapes are used and a sequence number is specified for the sequence number
key, the first tape is cleared beginning at that sequence number. All tapes
following the first tape are completely cleared. To clear the entire first
tape, 1 must be specified for the sequence number key.</p>
</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">All media after the first volume is cleared
automatically. If the save operation encounters active data on the first tape,
an inquiry message is sent, allowing the operator to either end
the save operation or clear the media. If the save operation encounters the
specified optical file on the first volume, an inquiry message is sent,
allowing the operator to either end the save operation or replace the file.
(*AFTER)
<p><strong>Note:</strong> This value is not valid for save files.</p>
</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">Active data on the media is replaced
automatically. Optical volumes are not initialized. Tapes
and save files are cleared automatically in the same way as the value 1.
(*REPLACE)</td>
</tr>
</table>
<p><strong>Data compaction.</strong> Whether device data compaction is
performed. The default is 1. The possible values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Device data compaction is not performed.
(*NO)</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Device data compaction is performed if the data
is saved to tape and all tape devices specified for the device key support the
compaction feature. (*DEV)
<p><strong>Note:</strong> If 1 is specified for the data compaction key and 2
is specified for the data compression key, only device data compaction is
performed if compaction is supported on the device. Otherwise, data compression
is performed if supported on the device.</p>
<p>If 1 is specified for the data compaction key and 1 is specified for the
data compression key, both device data compaction and device data compression
are performed if supported on the device.</p>
</td>
</tr>
</table>
<p><strong>Data compression.</strong> Whether data compression is performed. If
the save operation is being done while other jobs on the system are active and
software data compression is used, the overall system performance may be
affected. The default is 2. The possible values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">No data compression is performed. (*NO)</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">If the save operation is to tape and the target
device has the hardware compression feature, hardware compression is done. If
the feature is not present, or if the save data is written to optical
or save file, software data compression is done. Low (SNA)
software compression is used for all devices except optical DVD, which uses
medium (TERSE) software compression. (*YES)
<p><strong>Note:</strong> If 1 is specified for the data compression key and 1
is specified for the data compaction key, both device data compaction and
device data compression are performed if supported on the device.</p>
</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">If the tape device has the hardware compression
feature installed, processing proceeds as if 1 were specified for the data
compression key. If the compression feature is not installed or if save data is
written to optical or save file, processing proceeds as if 0
were specified for the data compression key. (*DEV)
<p><strong>Note:</strong> If 2 is specified for the data compression key and 1
is specified for the data compaction key, only device data compaction is
performed if compaction is supported on the device. Otherwise, data compression
is performed if supported on the device.</p>
</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">If the save operation is to a save file or
optical, low (SNA) software data compression is done. If the save operation is
being done while other jobs on the system are active and software data
compression is used, the overall system performance may be affected. Low
compression is usually faster than medium or high compression. The compressed
data is usually larger than if medium or high compression is used. (*LOW)</td>
</tr>
<tr>
<td align="left" valign="top"><em>4</em></td>
<td align="left" valign="top">If the save operation is to a save file or
optical, medium (TERSE) software data compression is done. If the save
operation is being done while other jobs on the system are active and software
data compression is used, the overall system performance may be affected.
Medium compression is usually slower than low compression but faster than high
compression. The compressed data is usually smaller than if low compression is
used and larger than if high compression is used. (*MEDIUM)</td>
</tr>
<tr>
<td align="left" valign="top"><em>5</em></td>
<td align="left" valign="top">If the save operation is to a save file or
optical, high (LZ1) software data compression is done. If the save operation is
being done while other jobs on the system are active and software data
compression is used, the overall system performance may be affected. High
compression is usually slower than low and medium compression.The compressed
data is usually smaller than if low or medium compression is used. (*HIGH)</td>
</tr>
</table>
<p><strong>Device path name.</strong> The path name of the device to which the
objects are saved.</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%">&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">BINARY(4)</td>
<td align="left" valign="top">Offset to first device path name</td>
</tr>
<tr>
<td align="left" valign="top" colspan="4"><strong>Note:</strong> These fields
repeat for each device path name</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to next device path 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">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Device path name</td>
</tr>
</table>
<p><em>Device path name.</em> The path name of the device to which the objects
are saved. The path name should be specified in the Qlg_Path_Name_T format. If
a pointer is specified in the path name format, it must be 16-byte aligned. If
not, unpredictable results may occur. For more information on this structure,
see <a href="../apiref/pns.htm">Path name format</a>. The possible value is:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top" nowrap><em>device-path-name</em></td>
<td align="left" valign="top">The path name of the<!-- diskette device,-->
<img src="delta.gif" alt="Start of change">media definition,<img src="deltaend.gif" alt="End of change"> media library device, optical device, save file, or tape device used to save
the objects. If a<!-- diskette device,-->
<img src="delta.gif" alt="Start of change">media definition,<img src="deltaend.gif" alt="End of change"> media library
device, optical device, or save file path name is specified, it must be the only element in the
array.
<p><img src="delta.gif" alt="Start of change">For information about creating and using a media definition,
see <a href="../rzaiu/rzaiurzaiuparandcon.htm">Save to multiple devices</a>
in the Backup and recovery topic
and the <a href="qsrcrtmd.htm">Create
Media Definition</a> (QSRCRTMD, QsrCreateMediaDefinition) API.<img src="deltaend.gif" alt="End of change">
</td>
</tr>
</table>
<p><em>Number in array.</em> The number of devices used during the save
operation. The possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>1-4</em></td>
<td align="left" valign="top">The number of devices used during the save
operation.</td>
</tr>
</table>
<p><em>Offset to first device path name.</em> The offset from the beginning of
the user space to the first device path name in the list. The possible value
is:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>n</em></td>
<td align="left" valign="top">The offset from the beginning of the user space
to the first device path name in the list.</td>
</tr>
</table>
<p><em>Offset to next device path name.</em> The offset from the beginning of
the user space to the next device path name in the list. The possible value
is:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>n</em></td>
<td align="left" valign="top">The offset from the beginning of the user space
to the next device path name in the list. If the current device path name is
the last device path name in the array, this value should be 0.</td>
</tr>
</table>
<p><em>Reserved.</em> Reserved. The possible value is:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>x'00'</em></td>
<td align="left" valign="top">This field should contain x'00's.</td>
</tr>
</table>
<p><strong>Directory subtree.</strong> Whether the directory subtrees are
included in the save operation. The default is 1. The possible values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">No subtrees are included in the save operation.
If a directory matches the object name pattern specified, the objects in the
directory are included. If the directory has subdirectories, neither the
subdirectories nor the objects in the subdirectories are included. (*NONE)</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The entire subtree of each directory that matches
the object name pattern is included. The subtree includes all subdirectories
and the objects within those subdirectories. (*ALL)</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">The objects in the first level of each directory
that matches the object name pattern are included. The subdirectories of each
matching directory are included, but the objects in the subdirectories are not
included. (*DIR)</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">Only the objects that exactly match the object
name pattern are included. If the object name pattern specifies a directory,
objects in the directory are not included. (*OBJ)</td>
</tr>
<tr>
<td align="left" valign="top"><em>4</em></td>
<td align="left" valign="top">The objects that match the object name pattern
are processed along with the storage for related objects. Objects that are
saved using this value can only be restored using SUBTREE(*STG). (*STG)</td>
</tr>
</table>
<p><strong>End of media option.</strong> The operation that is performed
automatically on the tape or optical volume after the save operation ends. If
more than one volume is used, this key applies only to the last volume used;
all other volumes are unloaded when the end of the volume is reached. The
default is 0.</p>
<p><strong>Note:</strong> This parameter is valid only if a tape or optical
device name is specified. For optical devices, 2 is the only value supported; 0
and 1 are ignored.</p>
<p>The possible values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The tape is automatically rewound, but not
unloaded, after the operation ends. (*REWIND)</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The tape does not rewind or unload after the
operation ends. It remains at the current position on the tape drive.
(*LEAVE)</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">The tape is automatically rewound and unloaded
after the operation ends. Some optical devices eject the volume after the
operation ends. (*UNLOAD)</td>
</tr>
</table>
<p><strong>Expiration date.</strong> The media in the device cannot be
overwritten until the expiration date.
The default is 0999999. The possible values
are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>0999999</em></td>
<td align="left" valign="top">The media in the device is protected permanently.
(*PERM)</td>
</tr>
<tr>
<td align="left" valign="top"><em>date</em></td>
<td align="left" valign="top">The date when protection for the media ends in
the format CYYMMDD:
<table cellpadding="5">
<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>
</td>
</tr>
</table>
<p><strong>Label.</strong> The file identifier of the media to be used for the
save operation. The default is *GEN. The possible values are as follows:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*GEN</em></td>
<td align="left" valign="top">The system generates the label.
<ul>
<li>For objects in libraries, this is the equivalent of LABEL(*LIB) on the Save
Object (SAVOBJ) and the Save Library (SAVLIB) commands.</li>
<li>For document library objects, this is the equivalent of LABEL(*GEN) on the
Save Document Library Object (SAVDLO) commands.</li>
<li>For objects in other file systems, the label is SAVyyyymmdd, where yyyymmdd is:
<table cellpadding="5">
<tr>
<td align="left" valign="top"><em>yyyy</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>
</li>
</ul>
</td>
</tr>
<tr>
<td align="left" valign="top" nowrap><em>file-identifier</em></td>
<td align="left" valign="top">The identifier (maximum of 17 characters) of the
tape file used for the save operation.</td>
</tr>
</table>
<!-- Start PATTERN -->
<p><strong>Name
pattern.</strong> Specifies a pattern to be used to include or omit
objects.</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%">&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">BINARY(4)</td>
<td align="left" valign="top">Offset to first pattern name</td>
</tr>
<tr>
<td align="left" valign="top" colspan="4"><strong>Note:</strong> These fields
repeat for each pattern name.</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to next pattern name</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">Option</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(11)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Pattern name</td>
</tr>
</table>
<p><em>Number in array.</em> The number of pattern names. The possible values
are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top" nowrap><em>1-n</em></td>
<td align="left" valign="top">The number of pattern names.</td>
</tr>
</table>
<p><em>Pattern Name.</em> Specifies a pattern name. The possible value is:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top" nowrap><em>pattern-name</em></td>
<td align="left" valign="top">The object name or pattern that can match many
names.</td>
</tr>
</table>
<p><em>Offset to first pattern name.</em> The offset from the beginning of the
user space to the first pattern name in the list. The possible value is:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>n</em></td>
<td align="left" valign="top">The offset from the beginning of the user space
to the first pattern name in the list.</td>
</tr>
</table>
<p><em>Offset to next pattern name.</em> The offset from the beginning of the
user space to the next pattern name in the list. The possible value is:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>n</em></td>
<td align="left" valign="top">The offset from the beginning of the user space
to the next pattern name in the list. If the current pattern name is the last
pattern name in the array, this value should be 0.</td>
</tr>
</table>
<p><em>Option.</em> Whether names that match the pattern should be included or
omitted from the save operation.</p>
<p><strong>Note:</strong> The subtree key specifies whether the subtrees are
included or omitted.</p>
<p>The possible values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">All objects which are included by the OBJ
parameter are included in the save except those objects which match the PATTERN
parameter. This value overrides objects that are included with option 1 and is
intended to be used to omit a subset of a previously selected patterns.
(*OMIT)</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Only objects which are included by the OBJ
parameter and match the PATTERN parameter are included in the save, unless
overridden by an omit specification. (*INCLUDE)</td>
</tr>
</table>
<p><em>Reserved.</em> Reserved. The possible value is:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>x'00'</em></td>
<td align="left" valign="top">This field should contain x'00's.</td>
</tr>
</table>
<p><strong>Object path name.</strong> The path name of the object to save. You
can specify a pattern for this path name.</p>
<!-- END PATTERN -->
<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">BINARY(4)</td>
<td align="left" valign="top">Offset to first object path name</td>
</tr>
<tr>
<td align="left" valign="top" colspan="4"><strong>Note:</strong> These fields
repeat for each object path name.</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to next object path name</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">Reserved</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">Option</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">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Object path name</td>
</tr>
</table>
<p><em>Number in array.</em> The number of object path names to be saved. The
possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top" nowrap><em>1-300</em></td>
<td align="left" valign="top">The number of object path names to be saved.</td>
</tr>
</table>
<p><em>Object path name.</em> The path name of the object to save. You can
specify a pattern for this path name. The path name should be specified in the
Qlg_Path_Name_T format. If a pointer is specified in the path name format, it
must be 16-byte aligned. If not, unpredictable results may occur. For more
information on this structure, see <a href="../apiref/pns.htm">Path name format</a>. The
possible value is:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top" nowrap><em>object-path-name</em></td>
<td align="left" valign="top">The object path name or pattern that can match
many names.</td>
</tr>
</table>
<p><em>Offset to first object path name.</em> The offset from the beginning of
the user space to the first object path name in the list. The possible value
is:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>n</em></td>
<td align="left" valign="top">The offset from the beginning of the user space
to the first object path name in the list.</td>
</tr>
</table>
<p><em>Offset to next object path name.</em> The offset from the beginning of
the user space to the next object path name in the list. The possible value
is:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>n</em></td>
<td align="left" valign="top">The offset from the beginning of the user space
to the next object path name in the list. If the current object path name is
the last object path name in the array, this value should be 0.</td>
</tr>
</table>
<p><em>Option.</em> Whether names that match the pattern should be included or
omitted from the save operation. When determining whether the name matches a
pattern, name patterns are always treated as relative to the current working
directory.</p>
<p><strong>Note:</strong> The subtree key specifies whether the subtrees are
included or omitted.</p>
<p>The possible values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The objects that match the object name pattern
are not saved. This value overrides objects that are included with option 1 and
is intended to be used to omit a subset of a previously selected pattern.
(*OMIT)</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The objects that match the object name pattern
are saved, unless overridden by an omit specification. (*INCLUDE)</td>
</tr>
</table>
<p><em>Reserved.</em> Reserved. The possible value is:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>x'00'</em></td>
<td align="left" valign="top">This field should contain x'00's.</td>
</tr>
</table>
<p><strong>Object precheck.</strong> Whether the save operation ends if any of
the selected objects cannot be saved. The default is 0. The possible values
are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The save operation does not end. Objects that can
be saved are saved. (*NO)</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The save operation ends. Nothing is saved unless
all of the selected objects can be saved. (*YES)</td>
</tr>
</table>
<p><strong>Optical file.</strong> The path name of the optical file that is
used for the save operation. The path name should be specified in the
Qlg_Path_Name_T format. If a pointer is specified in the path name format, it
must be 16-byte aligned. If not, unpredictable results may occur. For more
information on this structure, see <a href="../apiref/pns.htm">Path name format</a>. The
default is '*'. The possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>'*'</em></td>
<td align="left" valign="top">The system generates an optical file name in the
root directory of the optical volume.</td>
</tr>
<tr>
<td align="left" valign="top"><em>'Optical-directory-path-name/*'</em></td>
<td align="left" valign="top">The system generates an optical file name in the
specified directory of the optical volume.</td>
</tr>
<tr>
<td align="left" valign="top" nowrap><em>Optical file path name</em></td>
<td align="left" valign="top">The path name of the optical file that is used
for the save operation, beginning with the root directory of the volume.</td>
</tr>
</table>
<p><strong>Output.</strong> Whether a list of information about the saved
objects is created. The information can be directed to a spooled file, a stream
file, or a user space.</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%">&nbsp;</td>
<td align="center" valign="top" width="10%">&nbsp;</td>
<td align="left" valign="top" width="20%">CHAR(1)</td>
<td align="left" valign="top" width="60%">Option</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">Type of output information</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(14)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Output path name</td>
</tr>
</table>
<p><em>Option.</em> Whether a list of information about the saved objects is
created. The default is 0. The possible values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">No output is created. (*NONE)</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The output is printed with the job's spooled
output. (*PRINT)</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">The output is directed to an existing stream file
or user space specified by the output path name.</td>
</tr>
</table>
<p><em>Output path name.</em> The path name of the existing stream file or user
space to which the output of the API is directed. The path name should be
specified in the Qlg_Path_Name_T format. If a pointer is specified in the path
name format, it must be 16-byte aligned. If not, unpredictable results may
occur. For more information on this structure, see
<a href="../apiref/pns.htm">Path name format</a>. The possible value is:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top" nowrap><em>path-name</em></td>
<td align="left" valign="top">The path name of the existing stream file or user
space to which the output of the API is directed.</td>
</tr>
</table>
<p><em>Reserved.</em> Reserved. The possible value is:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>x'00'</em></td>
<td align="left" valign="top">This field should contain x'00's.</td>
</tr>
</table>
<p><em>Type of output information.</em> The type of information that is
directed to the spooled file, stream file, or user space specified for the
output key. The possible values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The file contains information about the command,
and an entry for each directory. (*SUMMARY)</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The file contains information about the command,
an entry for each directory, and an entry for each object that was not
successfully saved. (*ERR)</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">The file contains information about the command,
an entry for each directory, an entry for each object that was successfully
saved, and an entry for each object that was not successfully saved.
(*ALL)</td>
</tr>
</table>
<p><strong>Save while active.</strong> Whether an object can be updated while
it is being saved. The default is 0. The possible values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The objects that are in use are not saved.
Objects cannot be updated while they are being saved. (*NO)</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Objects can be saved and used at the same time.
The object checkpoints can occur at different times. (*YES)</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">Objects can be saved and used at the same time.
All of the object checkpoints occur at the same time. (*SYNC)</td>
</tr>
</table>
<p><strong>Save-while-active message queue.</strong> The path name of the
message queue that the save operation uses to notify the user that
save-while-active checkpoint processing is complete.</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%">&nbsp;</td>
<td align="center" valign="top" width="10%">&nbsp;</td>
<td align="left" valign="top" width="20%">CHAR(1)</td>
<td align="left" valign="top" width="60%">Option</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(15)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Save-while-active message-queue path name</td>
</tr>
</table>
<p><em>Option.</em> Whether a message should be used to notify the user that
save-while-active checkpoint processing is complete. The default is 0. The
possible values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">No notification message is sent. (*NONE)</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The notification message is sent to the work
station message queue. (*WRKSTN)</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">The notification message is sent to the specified
save-while-active message-queue path name.</td>
</tr>
</table>
<p><em>Reserved.</em></p>
<dl>
<dd>Reserved. The possible value is:<br>
<br>
</dd>
</dl>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>x'00'</em></td>
<td align="left" valign="top">This field should contain x'00's.</td>
</tr>
</table>
<p><em>Save-while-active message-queue path name.</em> The path name of the
message queue that will be used to notify the user that save-while-active
checkpoint processing is complete. The path name should be specified in the
Qlg_Path_Name_T format. If a pointer is specified in the path name format, it
must be 16-byte aligned. If not, unpredictable results may occur. For more
information on this structure, see <a href="../apiref/pns.htm">Path name format</a>. The
possible value is:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>Save-while-active message-queue path
name</em></td>
<td align="left" valign="top">The path name of the message queue.</td>
</tr>
</table>
<p><strong>Save-while-active option.</strong> The options that should be used
with the save-while-active key. The possible values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">No special save-while-active options will be
used. (*NONE)</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">When 1 or 2 is specified for the
save-while-active key, objects will be enabled to be saved when they are being
updated if the corresponding system attribute for the object is set.
<p>This option should be used only by applications to save objects that are
associated with the application and that have additional backup and recovery
considerations. See
<a href="../rzaiu/rzaiurzaiu300.htm">Save your system while it is active</a> in the
Backup and Recovery topic for additional
information.</p>
</td>
</tr>
</table>
<p><strong>Scan
objects.</strong> Whether objects will be scanned while being saved when exit
programs are registered with any of the integrated file system scan-related
exit points and whether objects that previously failed a scan should be
saved.</p>
<p>The integrated file system exit points are:</p>
<ul>
<li><a href="ifsopenexit.htm">Integrated File System Scan on Open Exit Program</a></li>
<li><a href="ifscloseexit.htm">Integrated File System Scan on Close Exit Program</a></li>
</ul>
<br>
<br>
<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%">CHAR(1)</td>
<td align="left" valign="top" width="60%">Scan during save</td>
</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%">CHAR(1)</td>
<td align="left" valign="top" width="60%">Save failed objects</td>
</tr>
</table>
<p><em>Scan during save.</em> Whether objects will be scanned while being saved
when exit programs are registered with any of the integrated file system
scan-related exit points. The default is 0. The possible values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Objects will not be scanned by the scan-related
exit programs. (*NO)</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Objects will be scanned according to the rules
described in the scan-related exit programs. (*YES)</td>
</tr>
</table>
<p><em>Save failed objects.</em> Whether objects that previously failed a scan
should be saved. The default is 0. The possible values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Objects that have either previously failed a scan
or that fail a scan by a QIBM_QP0L_SCAN_OPEN exit program during this save will
not be saved. (*NOSAVFAILED)</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Objects that have either previously failed a scan
or that fail a scan during this save will be saved. (*SAVFAILED)</td>
</tr>
</table>
<p><strong>Sequence number.</strong> The tape file sequence number to be used.
The default is -1. The possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top">The system saves the object starting after the
last sequence number on the first tape. If the first tape is full, an error
message is issued and the operation ends. (*END)</td>
</tr>
<tr>
<td align="left" valign="top" nowrap><em>1-16777215</em></td>
<td align="left" valign="top">The sequence number of the file. Any existing
files on the tape at or beyond this sequence number are overwritten.</td>
</tr>
</table>
<p><strong>System.</strong> Whether to process objects that exist on the local
system or remote systems. The default is 0. The possible values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Only local objects are processed. (*LCL)</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Only remote objects are processed. (*RMT)</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">Both local and remote objects are processed.
(*ALL)</td>
</tr>
</table>
<p><strong>Target release.</strong> The release level of the operating system
on which you intend to use the object being saved. The default is *CURRENT. The
possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*CURRENT</em></td>
<td align="left" valign="top">The object is to be restored to, and used on, the
release of the operating system that is currently running on your system. The
object can also be restored to a system with any subsequent release of the
operating system.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*PRV</em></td>
<td align="left" valign="top">The object is to be restored to the previous
release with modification level 0 of the operating system. The object can also
be restored to a system with any subsequent release of the operating system
installed.</td>
</tr>
<tr>
<td align="left" valign="top" nowrap><em>target-release</em></td>
<td align="left" valign="top">The release in the format VxRxMx. The object can
be restored to a system with the specified release or with any subsequent
release of the operating system.
<p>When you specify the target-release value, the format VxRxMx is used to
specify the release, where Vx is the version, Rx is the release, and Mx is the
modification level.</p>
<p>Valid values depend on the current version, release, and modification level,
and they change with each new release. See the valid values for TGTRLS
parameter table in the
<a href="../books/sc415304.pdf" target="_blank">Backup and Recovery</a>
<img src="wbpdf.gif" alt="Link to PDF"> book for a
complete list of valid values.</p>
</td>
</tr>
</table>
<p><strong>Update history.</strong> Whether to update the save history on
objects saved with this save operation. The save history is used when *LASTSAVE
is specified for the start time value of the change period key on a subsequent
save operation. The possible values include:</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%">&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="left" valign="top" colspan="4"><strong>Note:</strong> This field
repeats for each update history value.</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">Update history</td>
</tr>
</table>
<p><em>Number in array.</em> The number of update history values. The possible
values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>1-2</em></td>
<td align="left" valign="top">The number of update history values.</td>
</tr>
</table>
<p><em>Update history.</em> Whether to update the save history on objects saved
with this save operation. The save history is used when *LASTSAVE is specified
for the start time value of the change period key on a subsequent save
operation. The default is 0. The possible values include:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The save history is not updated. (*NO)</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The save history is updated. For file systems
that are accessed through the network server, the PC archive attribute is set
to No. For other file systems, the system archive attribute is set to No.
(*YES)</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">The system save history is updated. The system
archive attribute is set to No. (*PC)</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">The PC save history is updated. The PC archive
attribute is set to No. (*SYS)</td>
</tr>
</table>
<p><strong>Use optimum block size.</strong> Whether the optimum block size is
used for the save operation. The default is 1. The possible values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The optimum block size supported by the device is
not used. Save uses the default block size supported by all device types. The
tape volume can be duplicated to any media format by using the Duplicate Tape
(DUPTAP) command. (*NO)</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The optimum block size supported by all devices
is used. If the optimum block size is used, the following can occur:
<ul>
<li>Performance may improve.</li>
<li>The tape file that is created is only compatible with a device that
supports the block size used. Commands such as Duplicate Tape (DUPTAP) do not
duplicate files unless the files are being duplicated to a device that supports
the same block size that was used.</li>
<li>The value for the data compression key is ignored.</li>
</ul>
</td>
</tr>
</table>
<p><strong>Volume identifier.</strong> The volume identifiers of the volumes,
or the cartridge identifier of a tape in a tape media library device, on which
data is saved. The volumes must be placed in the device in the order specified
on this key. After all specified volumes are filled, the save operation
continues on whatever volumes are mounted on the device.</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%">&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">BINARY(4)</td>
<td align="left" valign="top">Length of each volume identifier</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to first volume identifier</td>
</tr>
<tr>
<td align="left" valign="top" colspan="4"><strong>Note:</strong> These fields
repeat for each volume identifier.</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to next volume identifier</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Volume identifier</td>
</tr>
</table>
<p><em>Length of each volume identifier.</em> The character length of each of
the volume identifiers. The possible value follows:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>n</em></td>
<td align="left" valign="top">The size of a single volume identifier. The
maximum size of a tape volume identifier is 6 characters.
The maximum size of an optical volume identifier is 32 characters. If a volume
identifier larger than the maximum size is entered for this key, it is
truncated to the maximum size.</td>
</tr>
</table>
<p><em>Number in array.</em> The number of volume identifiers that are used
during the save operation. The default is 0. The possible values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The volume currently placed in the device is
used. If 0 is specified for a tape media library device, volume identifiers
must be supplied by using the Tape Management exit program during the save or
restore operation. If 0 is specified, the length of each volume identifier
value is ignored. (*MOUNTED)
<p><strong>Note:</strong> This value cannot be specified for an optical media
library device.</p>
</td>
</tr>
<tr>
<td align="left" valign="top" nowrap><em>1-75</em></td>
<td align="left" valign="top">The number of volume identifiers used during the
save operation.</td>
</tr>
</table>
<p><em>Offset to first volume identifier.</em> The offset from the beginning of
the user space to the first volume identifier in the list. The possible value
is:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>n</em></td>
<td align="left" valign="top">The offset from the beginning of the user space
to the first volume identifier in the list.</td>
</tr>
</table>
<p><em>Offset to next volume identifier.</em> The offset from the beginning of
the user space to the next object volume identifier in the list. The possible
value is:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>n</em></td>
<td align="left" valign="top">The offset from the beginning of the user space
to the next volume identifier in the list. If the current volume identifier is
the last volume identifier in the array, this value should be 0.</td>
</tr>
</table>
<p><em>Volume identifier.</em> The volume identifiers of one or more volumes to
be used. The possible value is:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top" nowrap><em>Volume identifier</em></td>
<td align="left" valign="top">The volume identifiers of one or more volumes to
be used.</td>
</tr>
</table>
<br>
<br>
<h3>Dependencies between Keys</h3>
<p>The following two tables list the dependencies between the different keys.
If the dependency pertains only to a certain value, then that value is also
shown (key&nbsp;=&nbsp;<em>n</em>, where <em>n</em> is the value). Otherwise,
if the dependency is true for all values of the key, then only the name of the
key is given.</p>
<p>The following table lists the conditions where specifying a certain key
forces the use of another key.</p>
<table border width="80%">
<tr>
<th align="left" valign="bottom">If you specify...</th>
<th align="left" valign="bottom">...must be specified</th>
</tr>
<tr>
<td align="left" valign="top" width="50%">Device = optical library device</td>
<td align="left" valign="top" width="50%">Volume identifier</td>
</tr>
</table>
<p>The following table lists the conditions where specifying a certain key
excludes the user from using another key or a particular value of that key.</p>
<table border width="80%">
<tr>
<th align="left" valign="bottom">If you specify...</th>
<th align="left" valign="bottom">...cannot be specified</th>
</tr>
<tr>
<td align="left" valign="top"><img src="delta.gif" alt="Start of change">Device = media definition</td>
<td align="left" valign="top">
Optical file<br>
Sequence number<br>
Volume identifier<img src="deltaend.gif" alt="End of change"></td>
</tr>
<tr>
<td align="left" valign="top">Device = optical device</td>
<td align="left" valign="top">Label<br>
Sequence number<br>
Use optimum block
size</td>
</tr>
<tr>
<td align="left" valign="top">Device = save file</td>
<td align="left" valign="top">Clear = 2<br>
End of media option<br>
Expiration date<br>
Label<br>
Optical file<br>
Sequence number<br>
Use optimum block size<br>
Volume identifier</td>
</tr>
<tr>
<td align="left" valign="top">Device = tape device</td>
<td align="left" valign="top">Optical file</td>
</tr>
<tr>
<td align="left" valign="top">Save while active = 0</td>
<td align="left" valign="top">Save-while-active message queue<br>
Save-while-active option</td>
</tr>
</table>
<br>
<br>
<h3>Relationship to SAV Command</h3>
<p>Because of the relationship between the QsrSave API and the SAV command, the
following situations should be noted:</p>
<ul>
<li>Message text: Several messages produced by this API refer to parameters or
values of the SAV command (for example, *AFTER). To determine which key a given
parameter corresponds to, see <a href="#HDRKEYFLD2">Valid Keys</a>. To
determine which key value a given parameter value corresponds to, see
<a href="#HDRSOLDES2">Field Descriptions</a>.</li>
<li>Command type: The command type listed for the API on headings of displays
and print files is QsrSave for integrated file system objects. If QsrSave is
used to save objects in libraries or document library objects (DLOs), the
generated output indicates that the corresponding library or document library
objects (DLO) command generated the media.</li>
</ul>
<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%">CPF0001 E</td>
<td align="left" valign="top" width="85%">Error found on &amp;1 command.</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">CPF3700 E</td>
<td align="left" valign="top">All CPF37xx messages could be signalled. xx is
from 01 to FF.</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.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C31 E</td>
<td align="left" valign="top">Object type &amp;1 is not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C4D E</td>
<td align="left" valign="top">Length &amp;1 for key &amp;2 not valid.</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">CPF3C82 E</td>
<td align="left" valign="top">Key &amp;1 not valid for API &amp;2.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C83 E</td>
<td align="left" valign="top">Key &amp;1 not allowed with value specified for
key &amp;2.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C84 E</td>
<td align="left" valign="top">Key &amp;1 required with value specified for key
&amp;2.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C85 E</td>
<td align="left" valign="top">Value for key &amp;1 not allowed with value for
key &amp;2.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C86 E</td>
<td align="left" valign="top">Required key &amp;1 not specified.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C87 E</td>
<td align="left" valign="top">Key &amp;1 allows one value with special
value.</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">CPF5729 E</td>
<td align="left" valign="top">Not able to allocate object &amp;1.</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. &amp;1 unmonitored by &amp;2 at
statement &amp;5, instruction &amp;3.</td>
</tr>
</table>
<br>
<hr>
API introduced: V4R3
<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=
"back1.htm">Backup and Recovery APIs</a> | <a href="aplist.htm">APIs by
category</a></td>
</tr>
</table>
</body>
</html>
Reference in New Issue Copy Permalink