91 lines
5.1 KiB
HTML
91 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_Verify" />
|
||
|
|
<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_verify" />
|
||
|
|
<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_Verify</title>
|
||
|
|
</head>
|
||
|
|
<body id="cwbco_verify"><a name="cwbco_verify"><!-- --></a>
|
||
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<h1 class="topictitle1"><span class="apiname">cwbCO_Verify</span></h1>
|
||
|
|
<div><div class="section"><h4 class="sectiontitle">Purpose</h4><p>Verifies that a connection can be made to
|
||
|
|
a specific host service on an iSeries™ system.</p>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>
|
||
|
|
UINT CWB_ENTRY cwbCO_Verify(
|
||
|
|
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 previously returned from <span class="apiname">cwbCO_CreateSystem</span> or <span class="apiname">cwbCO_CreateSystemLike</span>.
|
||
|
|
It identifies the iSeries system to which to verify connectability.</dd>
|
||
|
|
<dt class="dlterm">cwbCO_Service service - input</dt>
|
||
|
|
<dd>The service to verify connectability to on the iSeries system. Valid values are those
|
||
|
|
listed in <a href="rzaikcwbcoservicedefines.htm#cwbco_servicedefines">Defines for cwbCO_Service</a>,
|
||
|
|
except for the value CWBCO_SERVICE_ANY. To verify connectability of ALL services,
|
||
|
|
specify CWBCO_SERVICE_ALL.</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_USER_TIMEOUT</dt>
|
||
|
|
<dd>The connect timeout value associated with the system object expired before
|
||
|
|
the connection verification attempt completed, so we stopped waiting.</dd>
|
||
|
|
<dt class="dlterm">CWB_COMMUNICATIONS_ERROR</dt>
|
||
|
|
<dd>An error occurred attempting to verify a connection to the service.</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Usage</h4><p>This API does not require user ID and password
|
||
|
|
to be set, nor will it cause a signon to occur, thus it will never prompt
|
||
|
|
for this information. It does not change the state of the system object in
|
||
|
|
any way.</p>
|
||
|
|
<p>If a connection to any specified service already exists, no
|
||
|
|
new connection will be established, and connectability will be considered
|
||
|
|
verified for that service.</p>
|
||
|
|
<p>If CWBCO_SERVICE_ALL is specified for verification,
|
||
|
|
the return code will be CWB_OK only if ALL services can be connected to. If
|
||
|
|
any one verification attempt fails, the return code will be that from the
|
||
|
|
first failure, although verification of the other services still will be attempted.</p>
|
||
|
|
<p>Since
|
||
|
|
this API does not establish a usable connection, it automatically will disconnect
|
||
|
|
when the verification is complete; therefore, do NOT call <span class="apiname">cwbCO_Disconnect</span> to
|
||
|
|
end the connection.</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>
|