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

103 lines
5.8 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_SetPortLookupMode" />
<meta name="DC.Relation" scheme="URI" content="rzaikcommapilist4.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_setportlookupmode" />
<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_SetPortLookupMode</title>
</head>
<body id="cwbco_setportlookupmode"><a name="cwbco_setportlookupmode"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1"><span class="apiname">cwbCO_SetPortLookupMode</span></h1>
<div><div class="section"><h4 class="sectiontitle">Purpose</h4><p>This function sets, for the specified system
object, how a host server port lookup will be done.</p>
</div>
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>
UINT CWB_ENTRY cwbCO_SetPortLookupMode(
cwbCO_SysHandle system,
cwbCO_PortLookupMode mode );</pre>
</div>
<div class="section"><h4 class="sectiontitle">Parameters</h4><dl><dt class="dlterm">cwbCO_SysHandle system - input</dt>
<dd>Handle that previously was returned by <span class="apiname">cwbCO_CreateSystem</span> or <span class="apiname">cwbCO_CreateSystemLike</span>.
It identifies the iSeries™ system.</dd>
<dt class="dlterm">cwbCO_PortLookupMode mode - input</dt>
<dd>Specifies port lookup method. Possible values are: <dl><dt class="dlterm">CWBCO_PORT_LOOKUP_SERVER</dt>
<dd>Lookup of a host server port will be done by contacting the host (iSeries)
server mapper each time the connection of a service is to be made when one
does not yet exist. The server mapper returns the port number that is then
used to connect to the desired service on the iSeries system.</dd>
<dt class="dlterm">CWBCO_PORT_LOOKUP_LOCAL</dt>
<dd>Lookup of a host server port will be done by lookup in the SERVICES file
on the PC itself.</dd>
<dt class="dlterm">CWBCO_PORT_LOOKUP_STANDARD</dt>
<dd>The "standard" port—that set by default for a given host server and in
use if no one has changed the services table on the iSeries system for that service—will
be used to connect to the desired service.</dd>
</dl>
<p>The latter two modes eliminate the iSeries server mapper connection and
its associated delay, network traffic, and load on the iSeries system.</p>
</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_INVALID_PARAMETER</dt>
<dd>The mode parameter is an invalid value.</dd>
<dt class="dlterm">CWB_RESTRICTED_BY_POLICY</dt>
<dd>A policy exists that prohibits the user from changing this value.</dd>
<dt class="dlterm">CWB_INV_AFTER_SIGNON</dt>
<dd>Signon has successfully occurred by using the specified system object,
so this setting no longer may be changed.</dd>
</dl>
</div>
<div class="section"><h4 class="sectiontitle">Usage</h4><p>This API cannot be used after a successful
signon has occurred for the specified system object. A signon has occurred
if either <span class="apiname">cwbCO_Signon</span> or <span class="apiname">cwbCO_Connect</span> has
been called successfully for this system object.</p>
<p>Use CWBCO_PORT_LOOKUP_SERVER
to be most certain of the accuracy of the port number for a service; however,
this requires an extra connection to the server mapper on the iSeries system
every time a new connection to a service is to be made.</p>
<p>Use CWBCO_PORT_LOOKUP_STANDARD
to achieve the best performance, although if the system administrator has
changed the ports of any iSeries Access host service in the service table
on that iSeries system,
this mode will not work.</p>
<p>Use CWBCO_PORT_LOOKUP_LOCAL for best performance
when the port for a iSeries Access host service has been changed on the iSeries system
represented by the system object. For this to work, entries for each host
service port must be added to a file on the PC named SERVICES. Each such entry
must contain first the standard name of the host service (for example, "as-rmtcmd"
without the quotes) followed by spaces and the port number for that service.
The SERVICES file is located in a subdirectory under the Windows<sup>®</sup> install
directory called <span class="uicontrol">system32\drivers\etc</span>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzaikcommapilist4.htm" title="Use the APIs to get and set other system object attributes, or determine if the attributes are restricted by policies.">Communications and security: Get and set attribute APIs</a></div>
</div>
</div>
</body>
</html>