109 lines
6.0 KiB
HTML
109 lines
6.0 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_Signon" />
|
||
|
|
<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_signon" />
|
||
|
|
<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_Signon</title>
|
||
|
|
</head>
|
||
|
|
<body id="cwbco_signon"><a name="cwbco_signon"><!-- --></a>
|
||
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<h1 class="topictitle1"><span class="apiname">cwbCO_Signon</span></h1>
|
||
|
|
<div><div class="section"><h4 class="sectiontitle">Purpose</h4><p>Sign the user on to the iSeries™ system
|
||
|
|
that is represented by the specified system object by using user ID and password. </p>
|
||
|
|
<div class="note"><span class="notetitle">Note:</span> Passing
|
||
|
|
an incorrect password on the <span class="apiname">cwbCO_Signon</span> API increments
|
||
|
|
the invalid signon attempts counter for the specified user. The user profile
|
||
|
|
is disabled if sufficient invalid passwords are sent to the host.</div>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>
|
||
|
|
UINT CWB_ENTRY cwbCO_Signon(
|
||
|
|
cwbCO_SysHandle system,
|
||
|
|
cwbSV_ErrHandle errorHandle );</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">cwbSV_ErrHandle errorHandle - input/output</dt>
|
||
|
|
<dd>Any returned messages will be written to this object. It is created with
|
||
|
|
the <span class="apiname">cwbSV_CreateErrHandle</span> API. The messages may be retrieved
|
||
|
|
through the <span class="apiname">cwbSV_GetErrText</span> API. If the parameter is set
|
||
|
|
to zero, or if the errorHandle is invalid, no messages will be retrieved.</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_UNKNOWN_USERID</dt>
|
||
|
|
<dd>The supplied user ID is not known to this system.</dd>
|
||
|
|
<dt class="dlterm">CWB_WRONG_PASSWORD</dt>
|
||
|
|
<dd>Password is not correct.</dd>
|
||
|
|
<dt class="dlterm">CWB_PASSWORD_EXPIRED</dt>
|
||
|
|
<dd>Password has expired.</dd>
|
||
|
|
<dt class="dlterm">CWB_USER_PROFILE_DISABLED</dt>
|
||
|
|
<dd>The user ID has been disabled.</dd>
|
||
|
|
<dt class="dlterm">CWB_INVALID_PASSWORD</dt>
|
||
|
|
<dd>One or more characters in the password is invalid or the password is too
|
||
|
|
long.</dd>
|
||
|
|
<dt class="dlterm">CWB_INVALID_USERID</dt>
|
||
|
|
<dd>One or more characters in the user ID is invalid or the user ID is too
|
||
|
|
long.</dd>
|
||
|
|
<dt class="dlterm">CWB_NOT_ENOUGH_MEMORY</dt>
|
||
|
|
<dd>Insufficient memory; may have failed to allocate temporary buffer.</dd>
|
||
|
|
<dt class="dlterm">CWB_API_ERROR</dt>
|
||
|
|
<dd>General API failure.</dd>
|
||
|
|
<dt class="dlterm">CWB_USER_CANCELLED </dt>
|
||
|
|
<dd>The user cancelled the signon process.</dd>
|
||
|
|
</dl>
|
||
|
|
<p>Other return codes commonly may be returned as a result
|
||
|
|
of a failed attempt to connect to the signon server. For a list of such return
|
||
|
|
codes, see comments for <span class="apiname">cwbCO_Connect</span>.</p>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Usage</h4><p>Both whether the user is prompted for user
|
||
|
|
ID and password, and whether the iSeries system actually is contacted
|
||
|
|
during user validation, are influenced by current system object settings,
|
||
|
|
such as user ID, password, Prompt Mode, Default User Mode, and Validate Mode.
|
||
|
|
See declarations for the get/set APIs of these attributes for more information.
|
||
|
|
If the iSeries system
|
||
|
|
as named in the specified system object does not exist in the System List,
|
||
|
|
and the system object Persistence Mode is set appropriately, then when <span class="apiname">cwbCO_Connect</span> or <span class="apiname">cwbCO_Signon</span> first
|
||
|
|
is called successfully, the iSeries system, as named in the system object, will
|
||
|
|
be added to the System List.</p>
|
||
|
|
<p>For more information about the Persistence
|
||
|
|
Mode, see the comments for <span class="apiname">cwbCO_SetPersistenceMode</span>. If
|
||
|
|
successful, and iSeries server
|
||
|
|
password caching is enabled, the password will be stored for the resulting
|
||
|
|
user ID in the PC's iSeries server password cache.</p>
|
||
|
|
<p>See also: </p>
|
||
|
|
<ul><li><a href="rzaikdifferences.htm#differences">Differences between cwbCO_Signon and cwbCO_VerifyUserIDPassword</a></li>
|
||
|
|
<li><a href="rzaiksimilarities.htm#similarities">Similarities between cwbCO_Signon and cwbCO_VerifyUserIDPassword</a></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>
|