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

280 lines
7.9 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>Move Folder to ASP (QHSMMOVF) 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. -->
<!-- QHSMMOVF SCRIPT A converted by B2H R4.1 (346) (CMS) by PMHALL at -->
<!-- RCHVMW2 on 7 Oct 1998 at 1:56:03 -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!-- File cleanup completed Feb 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 language="Javascript" src="../rzahg/synch.js" type="text/javascript">
</script>
<h2>Move Folder to ASP (QHSMMOVF) API</h2>
<div class="box" style="width: 70%;">
<br>
&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%">Folder name</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">Char(12)</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">Target auxiliary storage pool (ASP)</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Binary(4)</td>
</tr>
<tr>
<td align="center" valign="top">3</td>
<td align="left" valign="top">Error code</td>
<td align="left" valign="top">I/O</td>
<td align="left" valign="top">Char(*)</td>
</tr>
</table>
<br>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Move Folder to ASP (QHSMMOVF) API moves a root folder and its contents
from its existing auxiliary storage pool (ASP) to the specified target ASP
through a save and restore process. The API, however, will retain private
authorities to the objects that would normally be lost with a save and restore
operation.</p>
<br>
<h3>Restrictions</h3>
<p>The Move Folder to ASP (QHSMMOVF) API has the following restrictions:</p>
<ul>
<li>The folder must be a root folder and will be moved as such.</li>
<li>The folder and its contents must not be in use by other jobs.</li>
<li>Folders that were restored using the Restore Licensed Program (RSTLICPGM)
should not be moved.</li>
<li>After the root folder has been moved, the following parameters are changed:
<ul>
<li>The date last used will be set to blank.</li>
<li>The change date and time will be set to the current date and time.</li>
<li>The days used count will be set to zero.</li>
<li>The days used count reset will be set to blank.</li>
<li>The save date/time and restore date/time will be updated.</li>
</ul>
</li>
<li>The target ASP must have enough space for the folder and its objects in
order for the API to perform the move action.</li>
<li>The target ASP must be either the system ASP, a library-type ASP, or an
empty ASP.</li>
<li>The user must be enrolled in the system distribution directory.</li>
<li>Access codes are the responsibility of the user and will be lost.</li>
<li>A root folder that contains documents checked out or saved with STG(*FREE)
will not be moved.</li>
<li>A root folder that contains more than 99 subfolders will not be moved.</li>
</ul>
<br>
<h3>Authorities and Locks</h3>
<p>See Lock Conditions When Saving and Restoring Objects in the <a href=
"../books/sc415304.pdf" target="_blank">Backup and Recovery</a><img src=
"wbpdf.gif" alt="Link to PDF"> book for detailed information on locks that are
applied to objects during save operations.</p>
<p>To prevent access to other jobs, the folder is renamed to QHSMFLR.xxx, where
xxx is a numeric increment to allow multiple concurrent move operations.</p>
<p>The user profile must have *OBJALTER authority to the folder and its objects
if it does not have *ALLOBJ authority.</p>
<p>See Authority Required for Objects Used by Commands in the <a href=
"../books/sc415302.pdf" target="_blank">iSeries Security Reference</a> <img
src="wbpdf.gif" alt="Link to PDF"> book for detailed information on object
authorities required when you save objects.</p>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Folder name</strong></dt>
<dd>INPUT; CHAR(12)
<p>The name of the folder to be moved to the specified auxiliary storage pool
(ASP).</p>
</dd>
<dt><strong>Target auxiliary storage pool (ASP)</strong></dt>
<dd>INPUT; BINARY(4)
<p>The number of the auxiliary storage pool (ASP) to which the folder is to be
moved. You can use one of the following values for the ASP number:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top" nowrap><em>1-16</em></td>
<td align="left" valign="top">The number that was assigned to the ASP at
creation time. ASP 1 is the system ASP. This ASP must be different from the ASP
where the folder exists.</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>Error Messages</h3>
<table 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 width="15%" valign="top">CPF2115 E</td>
<td width="85%" valign="top">Object &amp;1 in &amp;2 type *&amp;3
damaged.</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">CPF8A00 E</td>
<td align="left" valign="top">All CPF8Axx messages could be signaled. xx is
from 01 to FF.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9000 E</td>
<td align="left" valign="top">All CPF90xx messages could be signaled. xx is
from 01 to FF.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9872 E</td>
<td align="left" valign="top">Program or service program &amp;1 in library
&amp;2 ended. Reason code &amp;3.</td>
</tr>
<tr>
<td align="left" valign="top">CPFB78B E</td>
<td align="left" valign="top">Errors encountered while moving or migrating
folder &amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">CPFB781 E</td>
<td align="left" valign="top">Not authorized to folder &amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">CPFB783 E</td>
<td align="left" valign="top">Folder &amp;1 cannot be moved or migrated into an
object-based ASP &amp;2.</td>
</tr>
<tr>
<td align="left" valign="top">CPFB784 E</td>
<td align="left" valign="top">Target ASP &amp;1 is not valid for the move or
migrate operation.</td>
</tr>
<tr>
<td align="left" valign="top">CPFB786 E</td>
<td align="left" valign="top">Insufficient disk capacity in ASP &amp;1 for
specified objects.</td>
</tr>
<tr>
<td align="left" valign="top">CPFB79E E</td>
<td align="left" valign="top">Auxiliary storage pool &amp;1 does not
exist.</td>
</tr>
<tr>
<td align="left" valign="top">CPFB790 E</td>
<td align="left" valign="top">Move or migrate of folder &amp;1 failed.</td>
</tr>
<tr>
<td align="left" valign="top">CPFB799 E</td>
<td align="left" valign="top">Unexpected condition with &amp;1 API. Reason
&amp; 6.</td>
</tr>
</table>
<br>
<hr>
API introduced: V4R3
<hr>
<table cellpadding="2" cellspacing="2" align="center">
<tr align="center">
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href="obj1.htm">Object API categories</a> | <a
href="aplist.htm">API by category</a></td>
</tr>
</table>
</body>
</html>