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

85 lines
4.7 KiB
HTML
Raw 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="cwbCO_SetPersistenceMode" />
<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_setpersistencemode" />
<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_SetPersistenceMode</title>
</head>
<body id="cwbco_setpersistencemode"><a name="cwbco_setpersistencemode"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1"><span class="apiname">cwbCO_SetPersistenceMode</span></h1>
<div><div class="section"><h4 class="sectiontitle">Purpose</h4><p>This function sets for the specified system
object if the system it represents (as named in the system object), along
with its attributes, may be added to the System List (if not already in the
list) once a signon successfully has occurred.</p>
</div>
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>
UINT CWB_ENTRY cwbCO_SetPersistenceMode(
cwbCO_SysHandle system,
cwbCO_PersistenceMode mode );</pre>
</div>
<div class="section"><h4 class="sectiontitle">Parameters</h4><dl><dt class="dlterm">cwbCO_SysHandle system - input</dt>
<dd>Handle returned previously from <span class="apiname">cwbCO_CreateSystem</span> or <span class="apiname">cwbCO_CreateSystemLike</span>.
It identifies the iSeries™ system.</dd>
<dt class="dlterm">cwbCO_PersistenceMode mode - input</dt>
<dd>Specifies the persistence mode. Possible values are: <dl><dt class="dlterm">CWBCO_MAY_MAKE_PERSISTENT</dt>
<dd>If the system that is named in the specified system object is not yet
in the System List, add it to the list once a successful signon has completed.
This will make the system, as defined by this system object, available for
selection by this AND other applications running, now or in the future, on
this personal computer (until the system is deleted from this list).</dd>
<dt class="dlterm">CWBCO_MAY_NOT_MAKE_PERSISTENT</dt>
<dd>The system that is named in the specified system object (along with its
attributes) may NOT be added to the System List.</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 successfully has 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>If the system as named
in the system object already is in the System List, this setting has no effect.</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>