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

399 lines
10 KiB
HTML
Raw Normal View History

2024-04-02 14:02:31 +00:00
<!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>End NetWare Connection (QfpzEndNtwCnn) 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. -->
<!-- Sec SCRIPT A converted by B2H R4.1 (346) (CMS) by V2KEA304 -->
<!-- at RCHVMW2 on 17 Feb 1999 at 11:05:09 -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!-- Edited by Kersten Jan 02 -->
<!--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>End NetWare Connection (QfpzEndNtwCnn) API</h2>
<div class="box" style="width: 80%;">
<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%">Input data</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">Length of input data</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">Format name</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(8)</td>
</tr>
<tr>
<td align="center" valign="top">4</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;Library Name/Service Program: QFPNTWE/QFPZAAPI<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The End NetWare Connection (QfpzEndNtwCnn) API ends a connection to a
NetWare server. Connections to a server that was started from this iSeries server
system, other iSeries servers, or workstations can be ended. Use the Work with
NetWare Connections (WRKNTWCNN) command to view a list of connections.</p>
<br>
<h3>Authorities and Locks</h3>
<dl>
<dt><em>Special Authority</em></dt>
<dd>The connection must have been started by the current job, or the caller
must have job control (*JOBCTL) special authority.</dd>
<dt><em>NetWare Authority</em></dt>
<dd>If this iSeries server did not start the connection being ended, the caller must
have operator privileges for the server.
<p><strong>Note:</strong> To have operator privileges, the caller must have an
authenticated connection to the server. The caller must be a NetWare user who
is a member of the OPERATORS property for the server.</p>
</dd>
</dl>
<br>
<h3><a name="HDRESCNRPG">Required Parameter Group</a></h3>
<dl>
<dt><strong>Input data</strong></dt>
<dd>INPUT; CHAR(*)
<p>The input data that identifies the connections to be ended. The format name
determines the format and content of this data. For detailed descriptions of
the data's format and content, see <a href="#HDRFECNFMT">Input Data
Formats</a>. For detailed descriptions of the fields in this structure, see <a
href="#HDRFECNFLD">Field Descriptions</a>.</p>
</dd>
<dt><strong>Length of input data</strong></dt>
<dd>INPUT; BINARY(4)
<p>The length of the input data structure.</p>
</dd>
<dt><strong>Format name</strong></dt>
<dd>INPUT; CHAR(8)
<p>The format and content of the input data structure.</p>
<p>The following formats are supported:</p>
<table cellpadding="5">
<!-- cols="30 70" -->
<tr>
<td align="left" valign="top"><em><a href="#endc0100">ENDC0100</a></em></td>
<td align="left" valign="top">End connections for the current job on the
specified servers.</td>
</tr>
<tr>
<td align="left" valign="top"><em><a href="#endc0200">ENDC0200</a></em></td>
<td align="left" valign="top">End the specified connection number on the
specified server.</td>
</tr>
</table>
<br>
</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><a name="HDRFECNFMT">Input Data Formats</a></h3>
<h4><a name="endc0100">ENDC0100 Format</a></h4>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="bottom">Dec</th>
<th align="center" valign="bottom">Hex</th>
</tr>
<tr>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">0</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Offset to server name</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="center" valign="top">4</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of server name</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="center" valign="top">8</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Server name</td>
</tr>
</table>
<br>
<br>
<h4><a name="endc0200">ENDC0200 Format</a></h4>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="bottom">Dec</th>
<th align="center" valign="bottom">Hex</th>
</tr>
<tr>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">0</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Offset to server name</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="center" valign="top">4</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of server name</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="center" valign="top">8</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Connection number</td>
</tr>
<tr>
<td align="center" valign="top">12</td>
<td align="center" valign="top">C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Server name</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRFECNFLD">Field Descriptions</a></h3>
<p><strong>Connection number.</strong> The connection number by which the
connection is known on the server.</p>
<p><strong>Length of server name.</strong> The length, in bytes, of the server
name.</p>
<p><strong>Offset to server name.</strong> The offset, in bytes, from the start
of the input data to the server name.</p>
<p><strong>Reserved.</strong> Set this field to binary zeros.</p>
<p><strong>Server name.</strong> The name of the server. If format ENDC0100 is
specified, the following special value may be used:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">End connections to all servers.</td>
</tr>
</table>
<br>
<h3>Error Messages</h3>
<table width="100%" cellpadding="5">
<!-- cols="15 85" -->
<tr>
<th align="left" valign="top">Message ID</th>
<th align="left" valign="top">Error Message Text</th>
</tr>
<tr>
<td width="15%" valign="top">CPF24B4 E</td>
<td width="85%" valign="top">Severe error while addressing parameter list.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C1D E</td>
<td align="left" valign="top">Length specified in parameter &amp;1 not
valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C21 E</td>
<td align="left" valign="top">Format name &amp;1 is not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C90 E</td>
<td align="left" valign="top">Literal value cannot be changed.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3CF1 E</td>
<td align="left" valign="top">Error code parameter not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF90FF E</td>
<td align="left" valign="top">*JOBCTL special authority required to do
requested operation.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9872 E</td>
<td align="left" valign="top">Program or service program &amp;1 in library
&amp;2 ended. Reason code &amp;3.</td>
</tr>
<tr>
<td align="left" valign="top">FPE0211 E</td>
<td align="left" valign="top">Parameter length &amp;1 not valid for field
&amp;2.</td>
</tr>
<tr>
<td align="left" valign="top">FPE0212 E</td>
<td align="left" valign="top">Field offset and length not within data.</td>
</tr>
<tr>
<td align="left" valign="top">FPE021B E</td>
<td align="left" valign="top">Connection &amp;1 on server &amp;2 not
found.</td>
</tr>
<tr>
<td align="left" valign="top">FPE0230 E</td>
<td align="left" valign="top">Connection type -1 must be single value.</td>
</tr>
<tr>
<td align="left" valign="top">FPE0231 E</td>
<td align="left" valign="top">Value &amp;1 not valid for connection type.</td>
</tr>
<tr>
<td align="left" valign="top">FPE0232 E</td>
<td align="left" valign="top">User &amp;1 not connected to server.</td>
</tr>
<tr>
<td align="left" valign="top">FPE023F E</td>
<td align="left" valign="top">Server operator privileges required.</td>
</tr>
</table>
<br>
<hr>
API introduced: V3R7
<hr>
<center>
<table cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
"sec.htm">Security APIs</a> | <a href="aplist.htm">APIs by category</a></td>
</tr>
</table>
</center>
</body>
</html>