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

168 lines
5.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>Deregister File System (QHFDRGFS) 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>Deregister File System (QHFDRGFS) 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%">File system name</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">Char(10)</td>
</tr>
<tr>
<td align="center" valign="top">2</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;Threadsafe: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Deregister File System (QHFDRGFS) API removes a file system and its functions from HFS support so that applications can no longer work with the file system through the HFS APIs. You can use the QHFDRGFS API to keep users from working with a file system while you upgrade to a new release.</p>
<p>If there are open files or directories in the file system being deregistered, HFS support automatically closes them before deregistering the file system. See <a href="xndjbssn.htm">End Job Session Exit Program</a> for details.</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><a name="Header_121">Required Parameter Group</a></h3>
<dl>
<dt><strong>File system name</strong></dt>
<dd>INPUT; CHAR(10);
<p>The name of the file system being deregistered.</p>
<p><strong>Note:</strong> You cannot deregister the document library services (DLS) file system, QDLS.</p>
<p>For deregistration to succeed, the file system cannot be in use. If a job that called the file system is not yet complete, the file system's Start Job Session exit program is still locked on behalf of that job, and the file system is still in use.</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">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">CPF1F81 E</td>
<td valign="top">API specific error occurred.</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">CPF1F9B E</td>
<td valign="top">Reregister or deregister file system failed.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1F92 E</td>
<td valign="top">File system &amp;1 not registered.</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">CPF1F98 E</td>
<td valign="top">Registration or deregistration cannot be done now.</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>