229 lines
7.2 KiB
HTML
229 lines
7.2 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">
|
||
|
|
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
|
||
|
|
<title>Save Storage Free Exit Program</title>
|
||
|
|
<!-- 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. -->
|
||
|
|
<!-- Begin Header Records =========================================== -->
|
||
|
|
<!-- BACKMST SCRIPT A converted by B2H R4.1 (346) (CMS) by v2kea304 at -->
|
||
|
|
<!-- RCHVMW2 on 26 April 1999 at 10:21:58 -->
|
||
|
|
<!-- File tagging validation completed Jan 2002 by v2cdijab -->
|
||
|
|
<!-- This file has undergone html cleanup June 2002 by JET -->
|
||
|
|
<!-- 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 Storage Free Exit Program</h2>
|
||
|
|
|
||
|
|
<div class="box" style="width: 70%;">
|
||
|
|
<br>
|
||
|
|
Required Parameter Group:<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
<table width="100%">
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="10%">1</td>
|
||
|
|
<td align="left" valign="top" width="50%">Path name pointers</td>
|
||
|
|
<td align="left" valign="top" width="20%">Input</td>
|
||
|
|
<td align="left" valign="top" width="20%">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">2</td>
|
||
|
|
<td align="left" valign="top">Return code pointer</td>
|
||
|
|
<td align="left" valign="top">Output</td>
|
||
|
|
<td align="left" valign="top">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">3</td>
|
||
|
|
<td align="left" valign="top">Return value pointer</td>
|
||
|
|
<td align="left" valign="top">Output</td>
|
||
|
|
<td align="left" valign="top">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">4</td>
|
||
|
|
<td align="left" valign="top">Function control block pointer</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<p>The Save Storage Free exit program is a user-specified program that is
|
||
|
|
called by <strong>Qp0lSaveStgFree()</strong> to save an i5/OS object of type
|
||
|
|
*STMF. This exit program can be either a procedure or program.</p>
|
||
|
|
|
||
|
|
<p>When the Save Storage Free exit program is given control, it should save the
|
||
|
|
object so it can be dynamically retrieved at a later time. The *STMF object is
|
||
|
|
locked when the exit program is called to prevent changes to it until the
|
||
|
|
storage free operation is complete. If the Save Storage Free exit program ends
|
||
|
|
unsuccessfully, it must return a valid <em>errno</em> in the storage pointed to
|
||
|
|
by the return value pointer. <strong>Qp0lSaveStgFree()</strong> then passes
|
||
|
|
this <em>errno</em> to its caller with a minus one return code.</p>
|
||
|
|
|
||
|
|
<p>Storage referred to by the path name pointers or the return code pointer
|
||
|
|
when the Save Storage Free exit program is called is destroyed or reused when
|
||
|
|
<strong>Qp0lSaveStgFree()</strong> regains control.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- Please NOTE: DO NOT DELETE THIS SECTION if this API has no authorities and locks. -->
|
||
|
|
<!-- Instead, use the commented out coding below to indicate NONE. -->
|
||
|
|
<h3>Authorities and Locks</h3>
|
||
|
|
|
||
|
|
<!-- Use this if there are no authorities and locks. -->
|
||
|
|
<p>None.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h3>Required Parameter Group</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><strong>Path names pointers</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(*)
|
||
|
|
|
||
|
|
<p>All of the path names to the *STMF object being storage freed. There is one
|
||
|
|
path name for each link to the object. These path names are in the
|
||
|
|
Qlg_Path_Name_T format and are in the UCS-2 CCSID. See <a href="../apiref/pns.htm">Path
|
||
|
|
name format</a> for more information on this format. For information about
|
||
|
|
UCS-2, see the <a href="../nls/rbagsglobalmain.htm">Globalization</a>
|
||
|
|
topic.</p>
|
||
|
|
|
||
|
|
<table border width="80%">
|
||
|
|
<tr>
|
||
|
|
<th align="left" valign="bottom" colspan="4">Path Name Pointers</th>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<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 path names</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">4</td>
|
||
|
|
<td align="center" valign="top">4</td>
|
||
|
|
<td align="left" valign="top">CHAR(12)</td>
|
||
|
|
<td align="left" valign="top">Reserved</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">16</td>
|
||
|
|
<td align="center" valign="top">10</td>
|
||
|
|
<td align="left" valign="top">ARRAY(*)</td>
|
||
|
|
<td align="left" valign="top">Array of path name pointers</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Array of path name pointers.</strong> Pointers to each
|
||
|
|
path name that <strong>Qp0lSaveStgFree()</strong> found for the object
|
||
|
|
identified by the path name on the call to <strong>Qp0lSaveStgFree()</strong>.
|
||
|
|
Each path name is in the Qlg_Path_Name_T format.</p>
|
||
|
|
|
||
|
|
<p><strong>Number of path names.</strong> The total number of path
|
||
|
|
names that <strong>Qp0lSaveStgFree()</strong> found for the object identified
|
||
|
|
by the caller of <strong>Qp0lSaveStgFree()</strong>.</p>
|
||
|
|
|
||
|
|
<p><strong>Reserved.</strong> A reserved field. This field must be
|
||
|
|
set to binary zero.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Return code pointer</strong></dt>
|
||
|
|
|
||
|
|
<dd>OUTPUT; BINARY(4)
|
||
|
|
|
||
|
|
<p>A pointer to an indicator that is returned to indicate whether the exit
|
||
|
|
program was successful or whether it failed. Valid values follow:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="5 95" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>0</em></td>
|
||
|
|
<td align="left" valign="top">The Save Storage Free exit program was
|
||
|
|
successful.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>-1</em></td>
|
||
|
|
<td align="left" valign="top">The Save Storage Free exit program was not
|
||
|
|
successful. The Return value pointer is set to indicate the error.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Return value pointer</strong></dt>
|
||
|
|
|
||
|
|
<dd>OUTPUT; BINARY(4)
|
||
|
|
|
||
|
|
<p>A pointer to a valid <em>errno</em> that is returned from the exit program
|
||
|
|
to identify the reason it was not successful.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Function control block pointer</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(*)
|
||
|
|
|
||
|
|
<p>A pointer to the data that is passed to <strong>Qp0lSaveStgFree()</strong>
|
||
|
|
on its call. <strong>Qp0lSaveStgFree()</strong> does not process the data that
|
||
|
|
is referred to by this pointer, but passes this pointer as a parameter when it
|
||
|
|
calls the exit program.</p>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Related Information</h3>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li><a href="qsavstgf.htm">Qp0lSaveStgFree()</a>--Save Storage Free</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
Exit program introduced: V4R3
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
<center>
|
||
|
|
<table cellpadding="2" cellspacing="2">
|
||
|
|
<tr align="center">
|
||
|
|
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
|
||
|
|
"back1.htm">Backup and Recovery APIs</a> | <a href="unix.htm">UNIX-Type
|
||
|
|
APIs</a> | <a href="aplist.htm">APIs by category</a></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</center>
|
||
|
|
</body>
|
||
|
|
</html>
|
||
|
|
|