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

68 lines
3.8 KiB
HTML
Raw Permalink Normal View History

2024-04-02 14:02:31 +00:00
<?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_DropConnections" />
<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_dropconnections" />
<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_DropConnections</title>
</head>
<body id="cwbobj_dropconnections"><a name="cwbobj_dropconnections"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1"><span class="apiname">cwbOBJ_DropConnections</span></h1>
<div><div class="section"><h4 class="sectiontitle">Purpose</h4><p>Drops all unused conversations to all systems
for the network print server for this process.</p>
</div>
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>
unsigned int CWB_ENTRY cwbOBJ_DropConnections(
cwbSV_ErrHandle errorHandle);</pre>
</div>
<div class="section"><h4 class="sectiontitle">Parameters</h4><dl><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_NO_ERROR </dt>
<dd>Successful completion.</dd>
<dt class="dlterm">CWBOBJ_RC_HOST_ERROR </dt>
<dd>Host error occurred. Text may be in errorHandle.</dd>
</dl>
</div>
<div class="section"><h4 class="sectiontitle">Usage</h4><p>The CWBOBJ.DLL maintains a pool
of available conversations to the network print server for use on the APIs.
These conversations normally time out after not having been used for 10 to
20 minutes and are then dropped. This API allows the application to clean
up the pool of conversations immediately without waiting for the timeout.
It can also be used at the end of the process to make sure that any conversations
are terminated. This API will drop all connections to all servers for this
process that are not "in use." In use connections include those with open
spooled files on them (for creating or reading from).</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>