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

103 lines
5.7 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_SetIPAddressLookupMode" />
<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_setipaddresslookupmode" />
<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_SetIPAddressLookupMode</title>
</head>
<body id="cwbco_setipaddresslookupmode"><a name="cwbco_setipaddresslookupmode"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1"><span class="apiname">cwbCO_SetIPAddressLookupMode</span></h1>
<div><div class="section"><h4 class="sectiontitle">Purpose</h4><p>This function sets, for the specified system
object, when iSeries™ Access
for Windows<sup>®</sup> dynamically
will lookup the iSeries system's
IP address when a connection is to be made. If the system name that is specified
when <span class="apiname">cwbCO_CreateSystem</span> or <span class="apiname">cwbCO_CreateSystemLike</span> was
called is an actual IP address, this setting is ignored, because iSeries Access
for Windows never
needs to lookup the address.</p>
</div>
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>
UINT CWB_ENTRY cwbCO_SetIPAddressLookupMode(
cwbCO_SysHandle system,
cwbCO_IPAddressLookupMode 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 from <span class="apiname">cwbCO_CreateSystem</span> or <span class="apiname">cwbCO_CreateSystemLike</span>.
It identifies the iSeries system.</dd>
<dt class="dlterm">cwbCO_IPAddressLookupMode mode - input</dt>
<dd>Specifies when the dynamic address lookup can occur. Possible values are: <dl><dt class="dlterm">CWBCO_IPADDR_LOOKUP_ALWAYS</dt>
<dd>Every time a connection is to occur, dynamically lookup the iSeries system's
IP address.</dd>
<dt class="dlterm">CWBCO_IPADDR_LOOKUP_1HOUR</dt>
<dd>Lookup the IP address dynamically if it has been at least one hour since
the last lookup for this iSeries system.</dd>
<dt class="dlterm">CWBCO_IPADDR_LOOKUP_1DAY</dt>
<dd>Lookup the IP address dynamically if it has been at least one day since
the last lookup for this iSeries system.</dd>
<dt class="dlterm">CWBCO_IPADDR_LOOKUP_1WEEK</dt>
<dd>Lookup the IP address dynamically if it has been at least one week since
the last lookup for this iSeries system.</dd>
<dt class="dlterm">CWBCO_IPADDR_LOOKUP_NEVER</dt>
<dd>Never dynamically lookup the IP address of this iSeries system, always use the IP address
that was last used for this iSeries system on this PC.</dd>
<dt class="dlterm">CWBCO_IPADDR_LOOKUP_AFTER_STARTUP</dt>
<dd>Lookup the IP address dynamically if Windows has been re-started since the
last lookup for this iSeries system.</dd>
</dl>
</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>Setting this to a value
other than CWB_IPADDR_LOOKUP_ALWAYS could shorten the time to connect to the iSeries system,
since the dynamic lookup may cause network traffic and take many seconds to
complete. If the dynamic lookup is not performed, there is a risk that the
IP address of the iSeries system will have changed and a connection
will either fail or will be made to the wrong iSeries system.</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>