ibm-information-center/dist/eclipse/plugins/i5OS.ic.cl_5.4.0.1/ovrsavf.htm

349 lines
14 KiB
HTML

<!doctype html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head><META http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Override with Save File (OVRSAVF)</title>
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body bgcolor="white">
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<a name="OVRSAVF.Top_Of_Page"></a>
<h2>Override with Save File (OVRSAVF)</h2>
<table width="100%">
<tr>
<td valign="top" align="left"><b>Where allowed to run: </b>All environments (*ALL)<br>
<b>Threadsafe: </b>No
</td>
<td valign="top" align="right">
<a href="#OVRSAVF.PARAMETERS.TABLE">Parameters</a><br>
<a href="#OVRSAVF.COMMAND.EXAMPLES">Examples</a><br>
<a href="#OVRSAVF.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="OVRSAVF"></a>
<p>The Override with Save File (OVRSAVF) command is used (1) to override or replace a file named in a program, (2) to override certain attributes of a file that are used by a program, or (3) to override the file named in a program and certain attributes of the overriding file.
</p>
<p>This command does not apply to save and restore commands.
</p>
<p>More information on overriding files is in the Files and file systems topic in the iSeries Information Center at http://www.ibm.com/eserver/iseries/infocenter.
</p>
<p>
<b>Note: </b>Using this command does not cause a file to be overridden immediately. Information provided on this command is stored until the file is used, at which time the file is overridden.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#OVRSAVF.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="OVRSAVF.PARAMETERS.TABLE">Parameters</a></h3>
<table border="1" cellpadding="4" cellspacing="0">
<!-- col1="10" col2="15" col3="30" col4="10" -->
<tr>
<th bgcolor="aqua" valign="bottom" align="left">Keyword</th>
<th bgcolor="aqua" valign="bottom" align="left">Description</th>
<th bgcolor="aqua" valign="bottom" align="left">Choices</th>
<th bgcolor="aqua" valign="bottom" align="left">Notes</th>
</tr>
<tr>
<td valign="top"><a href="#OVRSAVF.FILE"><b>FILE</b></a></td>
<td valign="top">File being overridden</td>
<td valign="top"><i>Name</i></td>
<td valign="top">Required, Positional 1</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#OVRSAVF.TOFILE"><b>TOFILE</b></a></td>
<td valign="top">Save file</td>
<td valign="top">Single values: <b><u>*FILE</u></b><br>Other values: <i>Qualified object name</i></td>
<td valign="top" rowspan="3">Optional, Positional 2</td>
</tr>
<tr>
<td valign="top">Qualifier 1: Save file</td>
<td valign="top"><i>Name</i></td>
</tr><tr>
<td valign="top">Qualifier 2: Library</td>
<td valign="top"><i>Name</i>, <b><u>*LIBL</u></b>, *CURLIB</td>
</tr><tr>
<td valign="top"><a href="#OVRSAVF.EXTEND"><b>EXTEND</b></a></td>
<td valign="top">Extend file</td>
<td valign="top">*NO, *YES</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#OVRSAVF.POSITION"><b>POSITION</b></a></td>
<td valign="top">Starting position in file</td>
<td valign="top">Single values: *START<br>Other values: <i>Element list</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Element 1: Retrieve order</td>
<td valign="top">
*RRN</td>
</tr>
<tr>
<td valign="top">Element 2: *RRN--Record number</td>
<td valign="top">
<i>Unsigned integer</i></td>
</tr>
<tr>
<td valign="top"><a href="#OVRSAVF.WAITFILE"><b>WAITFILE</b></a></td>
<td valign="top">Maximum file wait time</td>
<td valign="top"><i>Integer</i>, *IMMED, *CLS</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#OVRSAVF.SECURE"><b>SECURE</b></a></td>
<td valign="top">Secure from other overrides</td>
<td valign="top"><b><u>*NO</u></b>, *YES</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#OVRSAVF.OVRSCOPE"><b>OVRSCOPE</b></a></td>
<td valign="top">Override scope</td>
<td valign="top"><b><u>*ACTGRPDFN</u></b>, *CALLLVL, *JOB</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#OVRSAVF.SHARE"><b>SHARE</b></a></td>
<td valign="top">Share open data path</td>
<td valign="top">*NO, *YES</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#OVRSAVF.OPNSCOPE"><b>OPNSCOPE</b></a></td>
<td valign="top">Open scope</td>
<td valign="top">*ACTGRPDFN, *JOB</td>
<td valign="top">Optional</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#OVRSAVF.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="OVRSAVF.FILE"></a>
<h3>File being overridden (FILE)</h3>
<p>Specifies the save file in the using program to which this override command is applied. The specified file must be a save file when *FILE is specified in the <b>Save file (TOFILE)</b> parameter.
</p>
<p>
<b>Note: </b>The information in a save file has meaning only to Operating System/400 save and restore; redirecting another type of file to a save file or vice versa is not recommended.
</p>
<p>This is a required parameter.
</p>
<dl>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the save file.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#OVRSAVF.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="OVRSAVF.TOFILE"></a>
<h3>Save file (TOFILE)</h3>
<p>Specifies the save file that is used instead of the file specified on the <b>File being overridden (FILE)</b> parameter or, if *FILE is specified, specifies that certain attributes are overridden by parameters specified on this command. The parameters specified on this command override the other values specified in the save file or in the program.
</p>
<p><b>Single values</b>
</p>
<dl>
<dt><b><u>*FILE</u></b></dt>
<dd>The save file named in the FILE parameter has certain parameters overridden by the values specified in this command.
</dd>
</dl>
<p><b>Qualifier 1: Save file</b>
</p>
<dl>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the save file that is used instead of the overridden file name.
</dd>
</dl>
<p><b>Qualifier 2: Library</b>
</p>
<dl>
<dt><b><u>*LIBL</u></b></dt>
<dd>All libraries in the library list for the current thread are searched until the first match is found.
</dd>
</dl>
<dl>
<dt><b>*CURLIB</b></dt>
<dd>The current library for the job is used to locate the save file. If no library is specified as the current library for the job, QGPL is used.
</dd>
<dt><b><i>name</i></b></dt>
<dd>Specify the library where the save file is located.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#OVRSAVF.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="OVRSAVF.EXTEND"></a>
<h3>Extend file (EXTEND)</h3>
<p>Specifies, for output operations only, whether new records are added to the end of the data currently in the save file. This option is used to start processing after an application or a system failure. When this operation is completed, the file must contain the image of a single save operation made by a save command, or it may not be possible to restore objects from the save file. This parameter overrides the extend value specified in the program. The sequencing information in the file's records guarantees that after a system failure, a record cannot be skipped or sent twice.
</p>
<dl>
<dt><b>*NO</b></dt>
<dd>Records are not added to the end of the specified save file, but they replace existing records in the file. If the save file already contains records, an inquiry message is sent that clears the file or cancels the operation. If no value is specified for this parameter by the program or in an override, this is the default action assumed when the file is opened for output.
</dd>
<dt><b>*YES</b></dt>
<dd>New records are added to the end of the records contained in the save file.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#OVRSAVF.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="OVRSAVF.POSITION"></a>
<h3>Starting position in file (POSITION)</h3>
<p>Specifies the starting position for getting records from the save file. The first record to get is either at the beginning of the file (*START) or at a particular relative record number position in the file (*RRN). This parameter overrides the value specified in the program.
</p>
<p><b>Single values</b>
</p>
<dl>
<dt><b>*START</b></dt>
<dd>Get the first record in the file first. If no value is specified for this parameter by the program, or in an override, this is the default action assumed when the file is opened for input.
</dd>
</dl>
<p><b>Element 1: Retrieve order</b>
</p>
<dl>
<dt><b><i>*RRN</i></b></dt>
<dd>The relative record number specified for the second element of this parameter is the first record to get.
</dd>
</dl>
<p><b>Element 2: *RRN--Record number</b>
</p>
<dl>
<dt><b><i>unsigned-integer</i></b></dt>
<dd>Specify the record number (its position from the beginning of the file) of the record that you get first.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#OVRSAVF.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="OVRSAVF.WAITFILE"></a>
<h3>Maximum file wait time (WAITFILE)</h3>
<p>Specifies the number of seconds that the program waits for the file resources to be allocated when the file is opened, or the device or session resources to be allocated when an acquire operation is performed to the file. If the file resources cannot be allocated in the specified wait time, an error message is sent to the program.
</p>
<dl>
</dl>
<dl>
<dt><b>*IMMED</b></dt>
<dd>The program does not wait. Immediate allocation of file resources is required.
</dd>
</dl>
<dl>
<dt><b>*CLS</b></dt>
<dd>The default wait time specified in the class description is used as the wait time for the allocation of the file resources.
</dd>
<dt><b><i>integer</i></b></dt>
<dd>Specify the number of seconds that the program waits for the file resources to be allocated. Valid values range from 1 through 32767.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#OVRSAVF.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="OVRSAVF.SECURE"></a>
<h3>Secure from other overrides (SECURE)</h3>
<p>Specifies whether this file is protected from the effects of file override commands that were previously called.
</p>
<dl>
<dt><b>*NO</b></dt>
<dd>This file is not protected from other file overrides; its value is overridden by the effects of any file override commands that were previously called.
</dd>
<dt><b>*YES</b></dt>
<dd>This file is protected from the effects of any file override commands that were previously called.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#OVRSAVF.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="OVRSAVF.OVRSCOPE"></a>
<h3>Override scope (OVRSCOPE)</h3>
<p>Specifies the extent of influence (scope) of the override.
</p>
<dl>
<dt><b><u>*ACTGRPDFN</u></b></dt>
<dd>The scope of the override is determined by the activation group of the program that calls this command. When the activation group is the default activation group, the scope equals the call level of the calling program. When the activation group is not the default activation group, the scope equals the activation group of the calling program.
</dd>
<dt><b>*CALLLVL</b></dt>
<dd>The scope of the override is determined by the current call level. All open operations done at a call level that is the same as or higher than the current call level are influenced by this override.
</dd>
<dt><b>*JOB</b></dt>
<dd>The scope of the override is the job in which the override occurs.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#OVRSAVF.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="OVRSAVF.SHARE"></a>
<h3>Share open data path (SHARE)</h3>
<p>Specifies whether the open data path (ODP) is shared with other programs in the same routing step. When an ODP is shared, the programs accessing the file share facilities such as the file status and the buffer.
</p>
<dl>
<dt><b>*NO</b></dt>
<dd>The ODP is not shared with other programs in the routing step. A new ODP for the file is created and used every time a program opens the file.
</dd>
</dl>
<dl>
<dt><b>*YES</b></dt>
<dd>The same ODP is shared with each program in the job that also specifies *YES when it opens the file.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#OVRSAVF.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="OVRSAVF.OPNSCOPE"></a>
<h3>Open scope (OPNSCOPE)</h3>
<p>Specifies the extent of influence (scope) of the open operation.
</p>
<dl>
<dt><b>*ACTGRPDFN</b></dt>
<dd>The scope of the open operation is determined by the activation group of the program that called the OVRSAVF command processing program. If the activation group is the default activation group, the scope is the call level of the caller. If the activation group is a non-default activation group, the scope is the activation group of the caller.
</dd>
<dt><b>*JOB</b></dt>
<dd>The scope of the open operation is the job in which the open operation occurs.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#OVRSAVF.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="OVRSAVF.COMMAND.EXAMPLES">Examples</a> </h3>
<p>
<pre>
OVRSAVF FILE(ONLINE) POSITION(*RRN 100) SECURE(*YES)
</pre>
</p>
<p>This command overrides the file named ONLINE so that the first record gotten after the file is opened for input is relative record number 100. The file is also safe from overrides (in previous program calls).
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#OVRSAVF.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="OVRSAVF.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>CPF180C</b></dt>
<dd>Function &amp;1 not allowed.
</dd>
<dt><b>CPF1892</b></dt>
<dd>Function &amp;1 not allowed.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#OVRSAVF.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>