205 lines
6.5 KiB
HTML
205 lines
6.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>Assign SNADS File Server Object Access ID (QZDASNID) 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>Assign SNADS File Server Object Access ID (QZDASNID) API</h2>
|
||
|
|
|
||
|
|
<div class="box" style="width: 70%;">
|
||
|
|
<br>
|
||
|
|
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 server object handle</td>
|
||
|
|
<td align="left" valign="top" width="20%">Input</td>
|
||
|
|
<td align="left" valign="top" width="20%">Char(32)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">2</td>
|
||
|
|
<td align="LEFT" valign="TOP">Correlation</td>
|
||
|
|
<td align="LEFT" valign="TOP">Input</td>
|
||
|
|
<td align="LEFT" valign="TOP">Char(3000)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">3</td>
|
||
|
|
<td align="LEFT" valign="TOP">Correlation bytes provided</td>
|
||
|
|
<td align="LEFT" valign="TOP">Input</td>
|
||
|
|
<td align="LEFT" valign="TOP">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">4</td>
|
||
|
|
<td align="LEFT" valign="TOP">Product ID</td>
|
||
|
|
<td align="LEFT" valign="TOP">Input</td>
|
||
|
|
<td align="LEFT" valign="TOP">Char(7)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">5</td>
|
||
|
|
<td align="LEFT" valign="TOP">Access ID</td>
|
||
|
|
<td align="LEFT" valign="TOP">Output</td>
|
||
|
|
<td align="LEFT" valign="TOP">Char(8)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">6</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>
|
||
|
|
Default Public Authority: *EXCLUDE<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
Threadsafe: No<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<p>The Assign SNADS File Server Access ID (QZDASNID) API assigns an access ID to a specific file server object (FSO). An access ID lets the system know that a product is currently working with the file server object and that the file server object should not be deleted. An access ID is returned to the caller so that the access can be revoked at a later time. This API also increments the usage count of the FSO by one. Access IDs can be assigned to a particular file server object, and multiple accesses can be assigned at the same time. You can assign an access ID to an FSO 1 through 2 147 483 647 times, which equates to the usage count.</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>File server object handle</strong></dt>
|
||
|
|
<dd>INPUT; CHAR(32)
|
||
|
|
|
||
|
|
<p>The necessary linkage to the file server object. The value of this parameter should be taken from the FSO handle that was returned on the call to the Create SNADS File Server Object (QZDCRFSO) API.</p></dd>
|
||
|
|
|
||
|
|
<dt><strong>Correlation</strong></dt>
|
||
|
|
<dd>INPUT; CHAR(3000)
|
||
|
|
|
||
|
|
<p>Information defined by the caller that identifies the file server object or the file server object access ID. For example, the correlation could contain the message identifier of the message attached to the file server object. If the correlation bytes provided field is zero, this indicates that no correlation is to be stored with the FSO.</p></dd>
|
||
|
|
|
||
|
|
<dt><strong>Correlation bytes provided</strong></dt>
|
||
|
|
<dd>INPUT; BINARY(4)
|
||
|
|
|
||
|
|
<p>This field specifies the length of the correlation data.</p></dd>
|
||
|
|
|
||
|
|
<dt><strong>Product ID</strong></dt>
|
||
|
|
<dd>INPUT; CHAR(7)
|
||
|
|
|
||
|
|
<p>The identifier of the product that is using the QZDASNID API. The product ID is used together with the access ID to identify the file server object access.</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>OUTPUT; CHAR(8)
|
||
|
|
|
||
|
|
<p>The identifier used together with the product ID to identify the file server object access.</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">CPF3A0D E</td>
|
||
|
|
<td valign="top">Temporary server error.</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">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 &1 in library &2 ended. Reason code &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>
|