95 lines
5.1 KiB
HTML
95 lines
5.1 KiB
HTML
|
<?xml version="1.0" encoding="UTF-8"?>
|
||
|
|
<!DOCTYPE html
|
||
|
|
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
|
|
<html lang="en-us" xml:lang="en-us">
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||
|
|
<meta name="security" content="public" />
|
||
|
|
<meta name="Robots" content="index,follow" />
|
||
|
|
<meta http-equiv="PICS-Label" content='(PICS-1.1 "http://www.icra.org/ratingsv02.html" l gen true r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true r (n 0 s 0 v 0 l 0) "http://www.classify.org/safesurf/" l gen true r (SS~~000 1))' />
|
||
|
|
<meta name="DC.Type" content="reference" />
|
||
|
|
<meta name="DC.Title" content="cwbCO_Disconnect" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaikcommapilist2.htm" />
|
||
|
|
<meta name="copyright" content="(C) Copyright IBM Corporation 1999, 2006" />
|
||
|
|
<meta name="DC.Rights.Owner" content="(C) Copyright IBM Corporation 1999, 2006" />
|
||
|
|
<meta name="DC.Format" content="XHTML" />
|
||
|
|
<meta name="DC.Identifier" content="cwbco_disconnect" />
|
||
|
|
<meta name="DC.Language" content="en-us" />
|
||
|
|
<!-- 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. -->
|
||
|
|
<link rel="stylesheet" type="text/css" href="./ibmdita.css" />
|
||
|
|
<link rel="stylesheet" type="text/css" href="./ic.css" />
|
||
|
|
<title>cwbCO_Disconnect</title>
|
||
|
|
</head>
|
||
|
|
<body id="cwbco_disconnect"><a name="cwbco_disconnect"><!-- --></a>
|
||
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<h1 class="topictitle1"><span class="apiname">cwbCO_Disconnect</span></h1>
|
||
|
|
<div><div class="section"><h4 class="sectiontitle">Purpose</h4><p>Disconnect from the specified iSeries™ host
|
||
|
|
service.</p>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>
|
||
|
|
UINT CWB_ENTRY cwbCO_Disconnect(
|
||
|
|
cwbCO_SysHandle system,
|
||
|
|
cwbCO_Service service,
|
||
|
|
cwbSV_ErrHandle errorHandle );</pre>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Parameters</h4><dl><dt class="dlterm">cwbCO_SysHandle system - input</dt>
|
||
|
|
<dd>Handle that was returned by a previous call to either <span class="apiname">cwbCO_CreateSystem</span> or <span class="apiname">cwbCO_CreateSystemLike</span>.
|
||
|
|
It identifies the iSeries system from which to disconnect.</dd>
|
||
|
|
<dt class="dlterm">cwbCO_Service service - input</dt>
|
||
|
|
<dd>The service from which to disconnect on the iSeries system. Valid values are those
|
||
|
|
listed at the start of this file, except for the value CWBCO_SERVICE_ANY.
|
||
|
|
If CWBCO_SERVICE_ALL is specified, the connections to ALL connected services
|
||
|
|
will be ended, and all connection usage counts reset back to zero.</dd>
|
||
|
|
<dt class="dlterm">cwbSV_ErrHandle errorHandle - input/output</dt>
|
||
|
|
<dd>Any returned messages will be written to this object. It is created with
|
||
|
|
the <span class="apiname">cwbSV_CreateErrHandle</span> API. The messages may be retrieved
|
||
|
|
through the <span class="apiname">cwbSV_GetErrText</span> API. If the parameter is set
|
||
|
|
to zero, or if the errorHandle is invalid, no messages will be retrieved.</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Return Codes</h4><p>The following list shows common return
|
||
|
|
values.</p>
|
||
|
|
<dl><dt class="dlterm">CWB_OK</dt>
|
||
|
|
<dd>Successful completion.</dd>
|
||
|
|
<dt class="dlterm">CWB_INVALID_API_HANDLE</dt>
|
||
|
|
<dd>Invalid system handle.</dd>
|
||
|
|
<dt class="dlterm">CWB_SERVICE_NAME_ERROR</dt>
|
||
|
|
<dd>The service identifier is invalid.</dd>
|
||
|
|
<dt class="dlterm">CWB_NOT_CONNECTED</dt>
|
||
|
|
<dd>The single service was not connected.</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Usage</h4><p>This function should be called when a connection
|
||
|
|
that is established by using <span class="apiname">cwbCO_Connect</span> no longer is
|
||
|
|
needed.</p>
|
||
|
|
<p>If any service specified cannot be disconnected, the return
|
||
|
|
code will indicate this error. If more than one error occurs, only the first
|
||
|
|
one will be returned as the API return code.</p>
|
||
|
|
<dl><dt class="dlterm">Usage Notes<sup>®</sup> for
|
||
|
|
individual service disconnect:</dt>
|
||
|
|
<dd>This function will cause the usage count for this system object's specified
|
||
|
|
service to be decremented, and may or may not end the actual connection. For
|
||
|
|
more information, read the Usage Notes for the <span class="apiname">cwbCO_Connect</span> API. <p>Disconnecting
|
||
|
|
a service that is not currently connected results in CWB_NOT_CONNECTED.</p>
|
||
|
|
<p>An
|
||
|
|
individual service is gracefully disconnected.</p>
|
||
|
|
</dd>
|
||
|
|
<dt class="dlterm">Usage Notes for
|
||
|
|
CWBCO_SERVICE_ALL:</dt>
|
||
|
|
<dd>The return code CWB_NOT_CONNECTED is not returned when CWBCO_SERVICE_ALL
|
||
|
|
is specified, regardless of the number of connected services. <p>Requesting
|
||
|
|
that all active services be disconnected may generate messages on the iSeries.</p>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div>
|
||
|
|
<div class="familylinks">
|
||
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzaikcommapilist2.htm" title="These APIs allow you to connect to and disconnect from the iSeries system, and for related behavior">Communications and security: Connect and disconnect APIs</a></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|