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

104 lines
6.1 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_SetDefaultUserMode" />
<meta name="DC.Relation" scheme="URI" content="rzaikcommapilist3.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_setdefaultusermode" />
<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_SetDefaultUserMode</title>
</head>
<body id="cwbco_setdefaultusermode"><a name="cwbco_setdefaultusermode"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1"><span class="apiname">cwbCO_SetDefaultUserMode</span></h1>
<div><div class="section"><h4 class="sectiontitle">Purpose</h4><p>This function sets, for the specified system
object, the behavior with respect to any configured default user ID.</p>
</div>
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>
UINT CWB_ENTRY cwbCO_SetDefaultUserMode(
cwbCO_SysHandle system,
cwbCO_DefaultUserMode 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_DefaultUserMode mode - input</dt>
<dd>Specifies what will be done with the default user ID. Possible values
are: <dl><dt class="dlterm">CWBCO_DEFAULT_USER_MODE_NOT_SET</dt>
<dd>No default user mode is currently in use. When this mode is active, and
the Prompt Mode setting does not prohibit prompting, the user will be prompted
at signon or connect time to select which of the remaining default user modes
should be used from then on. The signon or connect cannot succeed until one
of these other mode values is selected. Setting the Default User Mode back
to this value will cause the prompt to appear the next time a default user
ID is needed by iSeries Access.</dd>
<dt class="dlterm">CWBCO_DEFAULT_USER_USE</dt>
<dd>When no user ID has explicitly been set (by using <span class="apiname">cwbCO_SetUserIDEx</span>)
and a signon is to occur, use the default user ID that is configured for the iSeries system
as named in the system object.</dd>
<dt class="dlterm">CWBCO_DEFAULT_USER_IGNORE</dt>
<dd>Specifies never to use a default user ID. When a signon takes place and
no user ID has explicitly been set for this system object instance, the user
will be prompted to enter a user ID if the Prompt Mode allows it (see <span class="apiname">cwbCO_SetPromptMode</span> comments),
and no initial value for the user ID will be filled in the prompt.</dd>
<dt class="dlterm">CWBCO_DEFAULT_USER_USEWINLOGON</dt>
<dd>The user ID that is used when logging on to Windows<sup>®</sup> will be used as the default
if no user ID explicitly has been set for this system object (by using <span class="apiname">cwbCO_SetUserIDEx</span>).</dd>
<dt class="dlterm">CWBCO_DEFAULT_USER_USE_KERBEROS</dt>
<dd>The kerberos principal created when logging into a Windows domain
will be used as the default if no user ID has explicitly been set for this
system object (using <span class="apiname">cwbCO_SetUserIDEx</span>).</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>
<dt class="dlterm">CWB_KERB_NOT_AVAILABLE</dt>
<dd>Kerberos security package is not available on this version of Windows.</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. The default user mode set
with this API will be ignored if a user ID has been set explicitly with the <span class="apiname">cwbCO_SetUserIDEx</span> API.</p>
<p>Error
code CWB_KERB_NOT_AVAILABLE will be returned if you attempt to set CWBCO_DEFAULT_USER_USE_KERBEROS
on a Windows platform
that does not support Kerberos.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzaikcommapilist3.htm" title="These APIs provide security validation and data.">Communication and security: Security validation and data APIs</a></div>
</div>
</div>
</body>
</html>