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

377 lines
9.5 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 Stream File (QHFMOVSF) 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. -->
<!-- GSA ADP Schedule Contract with IBM Corp. -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!--File Edited November 2001 -->
<!-- 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 Stream File (QHFMOVSF) API</h2>
<div class="box" style="width: 60%;">
<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%">Source file path name</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">Source file path name length</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Binary(4)</td>
</tr>
<tr>
<td align="center" valign="top">3</td>
<td align="left" valign="top">Target file path name</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(*)</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="left" valign="top">Target file path name length</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Binary(4)</td>
</tr>
<tr>
<td align="center" valign="top">5</td>
<td align="left" valign="top">Error code</td>
<td align="left" valign="top">I/O</td>
<td align="left" valign="top">Char(*)</td>
</tr>
</table>
<br>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Move Stream File (QHFMOVSF) API moves a single stream file from one directory to another and optionally changes the file's name. The file's attributes are not changed.</p>
<p> The QHFMOVSF API only moves stream files to a different path. To rename files within a path, see <a href="qhfrnmsf.htm">Rename Stream File (QHFRNMSF) API</a>.</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>Source file path name</strong></dt>
<dd>INPUT; CHAR(*)
<p>The path name of the file being moved. The file name is the last element of the path name.</p>
<p>The source file must be accessible. You cannot move a file that is already in use by another job.</p>
</dd>
<dt><strong>Source file path name length</strong></dt>
<dd>INPUT; BINARY(4)
<p>The length of the source file path name, in bytes.</p>
</dd>
<dt><strong>Target file path name</strong></dt>
<dd>INPUT; CHAR(*)
<p>The path name designating the new location and, optionally, the new name of the file being moved.</p>
<p>The target file cannot already exist. It must reside in a different path from the source file. The file name can be the same as or different from the source file name.</p>
</dd>
<dt><strong>Target file path name length</strong></dt>
<dd>INPUT; BINARY(4)
<p>The length of the target file path name, in bytes.</p>
</dd>
<dt><strong>Error code</strong></dt>
<dd>I/O; CHAR(*)
<p>The structure in which to return error information. For the format of the structure, see <a href="../apiref/error.htm#hdrerrcod">Error Code Parameter</a>.</p>
</dd>
</dl>
<br>
<h3>Error Messages</h3>
<table width="100%" cellpadding="3">
<!-- 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">CPF1F01 E</td>
<td valign="top">Directory name not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1F02 E</td>
<td valign="top">Directory not found.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1F03 E</td>
<td valign="top">New directory name same as old directory name.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1F06 E</td>
<td valign="top">Directory in use.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1F07 E</td>
<td valign="top">Authority not sufficient to access directory.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1F08 E</td>
<td valign="top">Damaged directory.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1F2A E</td>
<td valign="top">Number of open files exceeds limit.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1F2E E</td>
<td valign="top">Range of bytes in file in use.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1F21 E</td>
<td valign="top">File name not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1F22 E</td>
<td valign="top">File not found.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1F24 E</td>
<td valign="top">File name already exists.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1F26 E</td>
<td valign="top">File in use.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1F27 E</td>
<td valign="top">Authority not sufficient to access file.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1F28 E</td>
<td valign="top">Damaged file.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1F29 E</td>
<td valign="top">Use of reserved file name not allowed.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1F34 E</td>
<td valign="top">Attempted write operation beyond file size limit.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1F35 E</td>
<td valign="top">Read file operation failed.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1F36 E</td>
<td valign="top">Write file operation failed.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1F41 E</td>
<td valign="top">Severe error occurred while addressing parameter list.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1F42 E</td>
<td valign="top">Attribute information table not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1F43 E</td>
<td valign="top">Attribute name not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1F44 E</td>
<td valign="top">Attribute value is not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1F46 E</td>
<td valign="top">Use of reserved attribute name not allowed.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1F48 E</td>
<td valign="top">Path name not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1F52 E</td>
<td valign="top">Error code not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1F61 E</td>
<td valign="top">No free space available on media.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1F62 E</td>
<td valign="top">Requested function failed.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1F63 E</td>
<td valign="top">Media is write protected.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1F66 E</td>
<td valign="top">Storage needed exceeds maximum limit for user profile &amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1F71 E</td>
<td valign="top">Exception specific to file system occurred.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1F72 E</td>
<td valign="top">Internal file system error occurred.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1F73 E</td>
<td valign="top">Not authorized to use command.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1F74 E</td>
<td valign="top">Not authorized to object.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1F75 E</td>
<td valign="top">Error occurred during start-job-session function.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1F81 E</td>
<td valign="top">API specific error occurred.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1F82 E</td>
<td valign="top">Function not supported.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1F83 E</td>
<td valign="top">File system name &amp;1 not found.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1F84 E</td>
<td valign="top">Operation across file systems not allowed.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1F85 E</td>
<td valign="top">Not authorized to file system amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1F87 E</td>
<td valign="top">Missing or damaged exit program &amp;2.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1F97 E</td>
<td valign="top">File system &amp;1 in use.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C90 E</td>
<td valign="top">Literal value cannot be changed.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9872 E</td>
<td valign="top">Program or service program &amp;1 in library &amp;2 ended. Reason code &amp;3.</td>
</tr>
</table>
<br>
<hr>
API introduced: V2R1
<hr>
<center>
<table cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a
href="hfs1.htm">Hierarchical File System APIs</a> |
<a href="aplist.htm">APIs by category</a></td>
</tr>
</table>
</center>
</body>
</html>