89 lines
5.0 KiB
HTML
89 lines
5.0 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_IsConnected" />
|
||
|
|
<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_isconnected" />
|
||
|
|
<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_IsConnected</title>
|
||
|
|
</head>
|
||
|
|
<body id="cwbco_isconnected"><a name="cwbco_isconnected"><!-- --></a>
|
||
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<h1 class="topictitle1"><span class="apiname">cwbCO_IsConnected</span></h1>
|
||
|
|
<div><div class="section"><h4 class="sectiontitle">Purpose</h4><p>Find out if any, and how many, connections
|
||
|
|
to the iSeries™ system
|
||
|
|
that are using the specified system object currently exist.</p>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>
|
||
|
|
UINT CWB_ENTRY cwbCO_IsConnected(
|
||
|
|
cwbCO_SysHandle system,
|
||
|
|
cwbCO_Service service,
|
||
|
|
PULONG numberOfConnections );</pre>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Parameters</h4><dl><dt class="dlterm">cwbCO_SysHandle system - input</dt>
|
||
|
|
<dd>Handle returned previously from <span class="apiname">cwbCO_CreateSystem</span> or <span class="apiname">cwbCO_CreateSystemLike</span>.
|
||
|
|
It identifies the iSeries system.</dd>
|
||
|
|
<dt class="dlterm">cwbCO_Service service - input</dt>
|
||
|
|
<dd>The service to check for a connection. Any of the cwbCO_Service values
|
||
|
|
listed in <a href="rzaikcwbcoservicedefines.htm#cwbco_servicedefines">Defines for cwbCO_Service</a> are
|
||
|
|
valid. To find out if ANY service is connected, specify CWBCO_SERVICE_ANY.
|
||
|
|
To find out how many services are connected using this system object, specify
|
||
|
|
CWBCO_SERVICE_ALL.</dd>
|
||
|
|
<dt class="dlterm">PULONG numberOfConnections - output</dt>
|
||
|
|
<dd>Used to return the number of connections active for the service(s) that
|
||
|
|
are specified. If the service specified is not CWBCO_SERVICE_ALL, the value
|
||
|
|
returned will be either 0 or 1, since there can be at most one active connection
|
||
|
|
per service per system object. If CWBCO_SERVICE_ALL is specified, this could
|
||
|
|
be from zero to the possible number of services, since one connection per
|
||
|
|
service might be active.</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, all services specified are connected, or if CWBCO_SERVICE_ANY
|
||
|
|
is specified, at least one service is connected.</dd>
|
||
|
|
<dt class="dlterm">CWB_NOT_CONNECTED </dt>
|
||
|
|
<dd>If a single service was specified, that service is not connected. If the
|
||
|
|
value CWBCO_SERVICE_ANY was specified, there are NO active connections. If
|
||
|
|
the value CWBCO_SERVICE_ALL was specified, there is at least one service that
|
||
|
|
is NOT connected.</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_INVALID_POINTER </dt>
|
||
|
|
<dd>The numberOfConnections parameter is NULL.</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Usage</h4><p>If CWBCO_SERVICE_ALL was specified and CWB_NOT_CONNECTED
|
||
|
|
is returned, there may be some active connections, and the count of active
|
||
|
|
connections still will be passed back. To find out how many connections through
|
||
|
|
the specified system object exist, call this API and specify CWBCO_SERVICE_ALL.
|
||
|
|
If the return code is either CWB_OK or CWB_NOT_CONNECTED, the number of connections
|
||
|
|
that exist is stored in numberOfConnections.</p>
|
||
|
|
</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>
|