111 lines
6.2 KiB
HTML
111 lines
6.2 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_SetPromptMode" />
|
||
|
|
<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_setpromptmode" />
|
||
|
|
<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_SetPromptMode</title>
|
||
|
|
</head>
|
||
|
|
<body id="cwbco_setpromptmode"><a name="cwbco_setpromptmode"><!-- --></a>
|
||
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<h1 class="topictitle1"><span class="apiname">cwbCO_SetPromptMode</span></h1>
|
||
|
|
<div><div class="section"><h4 class="sectiontitle">Purpose</h4><p>This function sets, for the specified system
|
||
|
|
object, the prompt mode, which specifies when and if the user should be prompted
|
||
|
|
for user ID and password, or other information, when a signon is performed.</p>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>
|
||
|
|
UINT CWB_ENTRY cwbCO_SetPromptMode(
|
||
|
|
cwbCO_SysHandle system,
|
||
|
|
cwbCO_PromptMode 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_PromptMode - input</dt>
|
||
|
|
<dd>Specifies the prompt mode. Possible values are: <dl><dt class="dlterm">CWBCO_PROMPT_IF_NECESSARY</dt>
|
||
|
|
<dd>iSeries Access
|
||
|
|
for Windows<sup>®</sup> will
|
||
|
|
prompt if either the user ID or password have not been explicitly set or cannot
|
||
|
|
be retrieved from the persistent configuration for this system, the password
|
||
|
|
cache (if enabled), or by some other means. <p>If the Default User Mode has
|
||
|
|
not been set, and if for this iSeries system the user has not been
|
||
|
|
prompted yet for default user ID, iSeries access for Windows will
|
||
|
|
prompt for it at <span class="apiname">cwbCO_Connect</span> or <span class="apiname">cwbCO_Signon</span> time</p>
|
||
|
|
</dd>
|
||
|
|
<dt class="dlterm">CWBCO_PROMPT_ALWAYS</dt>
|
||
|
|
<dd>iSeries Access
|
||
|
|
for Windows will
|
||
|
|
always prompt when a signon is to occur for the specified system object,
|
||
|
|
even if a successful signon using the same user ID to the same iSeries system
|
||
|
|
has occurred using a different system object. Since a signon can occur only
|
||
|
|
once for a system object, this means that exactly one prompt per system object
|
||
|
|
will occur. Additional explicit signon calls will do nothing (including prompt).
|
||
|
|
See two exceptions to using this mode in the usage notes below.</dd>
|
||
|
|
<dt class="dlterm">CWBCO_PROMPT_NEVER</dt>
|
||
|
|
<dd>iSeries Access
|
||
|
|
for Windows never
|
||
|
|
will prompt for user ID and password, or for default user ID. When this mode
|
||
|
|
is used, a call to any API that requires a signon for completion (for example, <span class="apiname">cwbCO_Signon</span> or <span class="apiname">cwbCO_Connect</span>) will fail if either the user ID or password have not been set and cannot
|
||
|
|
be programmatically retrieved (from the iSeries password cache). This mode should
|
||
|
|
be used when either <ul><li>iSeries Access
|
||
|
|
for Windows is
|
||
|
|
running on a PC that is unattended or for some other reason cannot support
|
||
|
|
end-user interaction.</li>
|
||
|
|
<li>The application itself is prompting for or otherwise fetching the user
|
||
|
|
ID and password, and explicitly setting them by using <span class="apiname">cwbCO_SetUserIDEx</span> and <span class="apiname">cwbCO_SetPassword</span>.</li>
|
||
|
|
</ul>
|
||
|
|
</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. Setting the prompt mode to
|
||
|
|
CWBCO_PROMPT_ALWAYS will not prompt the user in the following two cases: </p>
|
||
|
|
<ul><li>A user ID and password explicitly have been set with the <span class="apiname">cwbCO_setUserIDEx</span> and <span class="apiname">cwbCO_SetPassword</span> APIs.</li>
|
||
|
|
<li>Use Windows logon info (CWBCO_DEFAULT_USER_USEWINLOGON)
|
||
|
|
has been set with the cwbCO_SetDefaultUserMode API.</li>
|
||
|
|
</ul>
|
||
|
|
</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>
|