ibm-information-center/dist/eclipse/plugins/i5OS.ic.rzaik_5.4.0.1/rzaikcwbobjsetconnectionsto.htm

72 lines
4.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="cwbOBJ_SetConnectionsToKeep" />
<meta name="DC.Relation" scheme="URI" content="rzaikobjapilist12.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="cwbobj_setconnectionstokeep" />
<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>cwbOBJ_SetConnectionsToKeep</title>
</head>
<body id="cwbobj_setconnectionstokeep"><a name="cwbobj_setconnectionstokeep"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1"><span class="apiname">cwbOBJ_SetConnectionsToKeep</span></h1>
<div><div class="section"><h4 class="sectiontitle">Purpose</h4><p>Set the number of connections that should
be left active for a particular system. Normally, the cwbobj.dll will time
out and drop connections after they have not been used for a while. With this
API you can force it to leave open a certain number of connections for this
system.</p>
</div>
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>
unsigned int CWB_ENTRY cwbOBJ_SetConnectionsToKeep(
const char *systemName
unsigned int connections
cwbSV_ErrHandle errorHandle);</pre>
</div>
<div class="section"><h4 class="sectiontitle">Parameters</h4><dl><dt class="dlterm">const char *systemName - input</dt>
<dd>Pointer to the system name contained in ASCIIZ string.</dd>
<dt class="dlterm">unsigned int connections - input</dt>
<dd>The number to of connections to keep open.</dd>
<dt class="dlterm">cwbSV_ErrHandle errorHandle - output</dt>
<dd>Optional, may be 0. 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, no messages will be retrievable.</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_PARAMETER </dt>
<dd>Invalid parameter specified.</dd>
</dl>
</div>
<div class="section"><h4 class="sectiontitle">Usage</h4><p>The default number of connections left open
per system is 0. The connections are made per process, so this API only affects
connections under the process it is called under. Setting the number of connections
to be left open does not open any new connections.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzaikobjapilist12.htm" title="The following iSeries Access for Windows APIs pertain to server programs. The APIs are listed alphabetically.">Server program APIs for iSeries Access for Windows</a></div>
</div>
</div>
</body>
</html>