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

229 lines
6.6 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>Set Stream File Size (QHFSETSZ) 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>Set Stream File Size (QHFSETSZ) 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="40%">Open file handle</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="30%">Char(16)</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">File size</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Binary(4) Unsigned</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>
&nbsp;&nbsp;Threadsafe: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Set Stream File Size (QHFSETSZ) API sets the size of a stream file in bytes. Applications can use the QHFSETSZ API to increase or decrease the size of a stream file that has been opened with write only or
read/write access.</p>
<p>Existing locks on the file are maintained. If the entire file is locked, you cannot change its size. If part of the file is locked, the new size cannot interfere with the locked part. The description of the file size parameter discusses these restrictions.</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>Open file handle</strong></dt>
<dd>INPUT; CHAR(16)
<p>The handle returned from the Open Stream File (QHFOPNSF) API when the file was opened. The file must have been opened with write only or read/write access.</p>
</dd>
<dt><strong>File size</strong></dt>
<dd>INPUT; BINARY(4) UNSIGNED
<p>The size to make the file, in bytes. The size cannot start or end within a range of bytes locked in deny write or deny read/write mode, and it cannot extend beyond a locked range. If a locked range was not previously within the file, the file cannot be extended to include that range. If a locked range is within the file, the file cannot be truncated to exclude that range.</p>
<p>When the file size is increased, the file system may not define the value of the new bytes. When the file size is decreased, the data in the truncated part of the file is lost.</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">CPF1F2B E</td>
<td valign="top">Write operation not allowed to file opened for read only.</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">CPF1F25 E</td>
<td valign="top">File handle not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1F28 E</td>
<td valign="top">Damaged file.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1F4B E</td>
<td valign="top">Value for number of bytes not valid.</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">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">CPF1F82 E</td>
<td valign="top">Function not supported.</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">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>