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

170 lines
5.4 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>Revoke SNADS File Server Object Access ID (QZDRVKID) 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. -->
<!-- NETMG2 SCRIPT A converted by B2H R4.1 (346) (CMS) by HOLTJM at -->
<!-- RCHVMW2 on 29 Jan 1999 at 10:01:37 -->
<!--File Edited October 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>Revoke SNADS File Server Object Access ID (QZDRVKID) 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%">Product ID</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">Char(7)</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="LEFT" valign="TOP">Access ID</td>
<td align="LEFT" valign="TOP">Input</td>
<td align="LEFT" valign="TOP">Char(8)</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: *EXCLUDE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Revoke SNADS File Server Object Access ID (QZDRVKID) API revokes an access ID to a specific file server object (FSO) that was previously assigned. Revoking an access lets the system know that the current process has finished working with the file server object. The access ID that was originally assigned to the file server object must be passed as input. This API also decrements the usage count of the file server object by one.</p>
<br>
<h3>Authorities and Locks</h3>
<dl>
<dt><em>API Public Authority</em></dt>
<dd>*EXCLUDE</dd>
</dl>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Product ID</strong></dt>
<dd>INPUT; CHAR(7)
<p>The identifier of the product that is using the QZDLSTID API. This parameter is necessary to group access IDs by product and to facilitate better cleanup of file server objects. For example, an installed product that was creating FSOs is removed from the system, but FSOs still exist that are referred to by that product. The SNADS cleanup routines check to ensure that the product is installed, and if the product was removed, the SNADS cleanup routines delete the remaining FSOs referred to by that product.</p>
<p>Valid values for this parameter are as follows:</p>
<table cellpadding="3">
<!-- cols="15 85" -->
<tr>
<td valign="top"><em>Product ID</em></td>
<td valign="top">The product ID of a product that is installed on the iSeries server.</td>
</tr>
<tr>
<td valign="top"><em>QMSFPRD</em></td>
<td valign="top">The MSF product identifier. This value can be used for all file server objects that are referred to by the MSF messages.</td>
</tr>
</table>
<br></dd>
<dt><strong>Access ID</strong></dt>
<dd>INPUT; CHAR(8)
<p>The identifier that is used along with the product ID to identify the file server object access. The value of this parameter should be taken from the access ID that was returned on the call to the Assign SNADS File Server Object Access ID (QZDASNID) API.</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">CPF24B4 E</td>
<td valign="top">Severe error while addressing parameter list.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3A09 E</td>
<td valign="top">System error.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3A12 E</td>
<td valign="top">Interface error.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3A13 E</td>
<td valign="top">Access ID not valid.</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">CPF3CF1 E</td>
<td valign="top">Error code parameter not valid.</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: V3R6
<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="off1a.htm">Office APIs</a> | <a href=
"aplist.htm">APIs by category</a></td>
</tr>
</table>
</body>
</html>