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

131 lines
7.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_ChangePassword" />
<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_changepassword" />
<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_ChangePassword</title>
</head>
<body id="cwbco_changepassword"><a name="cwbco_changepassword"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1"><span class="apiname">cwbCO_ChangePassword</span></h1>
<div><div class="section"><h4 class="sectiontitle">Purpose</h4><p>Changes the password of the specified user
on the iSeries™ system
from a specified old to a specified new value. This API does NOT use the user
ID and password that currently are set in the given system object, nor does
it change these values.</p>
</div>
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>
UINT CWB_ENTRY cwbCO_ChangePassword(
cwbCO_SysHandle system,
LPCSTR userID,
LPCSTR oldPassword,
LPCSTR newPassword,
cwbSV_ErrHandle errorHandle);</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">LPCSTR userID - input</dt>
<dd>A pointer to an ASCIIZ string that contains the user ID. The maximum length
is CWBCO_MAX_USER_ID + 1 characters, including the null terminator.</dd>
<dt class="dlterm">LPCSTR oldPassword - input</dt>
<dd>A pointer to a buffer which contains the old password. The maximum length
is CWBCO_MAX_PASSWORD + 1 bytes, including the null terminator.</dd>
<dt class="dlterm">LPCSTR newPassword - input</dt>
<dd>A pointer to a buffer which contains the new password. The maximum length
is CWBCO_MAX_PASSWORD + 1 bytes, including the null terminator.</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_INVALID_POINTER</dt>
<dd>A pointer parameter is NULL.</dd>
<dt class="dlterm">CWB_GENERAL_SECURITY_ERROR</dt>
<dd>A general security error occurred. The user profile does not have a password
or the password validation program found an error in the password.</dd>
<dt class="dlterm">CWB_INVALID_PASSWORD</dt>
<dd>One or more characters in the new 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_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_USER_PROFILE_DISABLED</dt>
<dd>The user ID has been disabled.</dd>
<dt class="dlterm">CWB_PW_TOO_LONG</dt>
<dd>New password longer than maximum accepted length.</dd>
<dt class="dlterm">CWB_PW_TOO_SHORT</dt>
<dd>New password shorter than minimum accepted length.</dd>
<dt class="dlterm">CWB_PW_REPEAT_CHARACTER</dt>
<dd>New password contains a character used more than once.</dd>
<dt class="dlterm">CWB_PW_ADJACENT_DIGITS</dt>
<dd>New password has adjacent digits.</dd>
<dt class="dlterm">CWB_PW_CONSECUTIVE_CHARS</dt>
<dd>New password contains a character repeated consecutively.</dd>
<dt class="dlterm">CWB_PW_PREVIOUSLY_USED</dt>
<dd>New password was previously used.</dd>
<dt class="dlterm">CWB_PW_DISALLOWED_CHAR</dt>
<dd>New password uses an installation-disallowed character.</dd>
<dt class="dlterm">CWB_PW_NEED_NUMERIC</dt>
<dd>New password must contain at least one numeric.</dd>
<dt class="dlterm">CWB_PW_MATCHES_OLD</dt>
<dd>New password matches old password in one or more character positions.</dd>
<dt class="dlterm">CWB_PW_NOT_ALLOWED</dt>
<dd>New password exists in a dictionary of disallowed passwords.</dd>
<dt class="dlterm">CWB_PW_CONTAINS_USERID</dt>
<dd>New password contains user ID as part of the password.</dd>
<dt class="dlterm">CWB_PW_LAST_INVALID_PWD</dt>
<dd>The next invalid password will disable the user profile.</dd>
<dt class="dlterm">CWB_NOT_ENOUGH_MEMORY</dt>
<dd>Insufficient memory; may have failed to allocate temporary buffer.</dd>
<dt class="dlterm">CWB_NON_REPRESENTABLE_UNICODE_CHAR</dt>
<dd>One or more input Unicode characters have no representation in the codepage
being used.</dd>
<dt class="dlterm">CWB_API_ERROR</dt>
<dd>General API failure.</dd>
</dl>
</div>
<div class="section"><h4 class="sectiontitle">Usage</h4><p>Valid password lengths depend on the current
setting of the iSeries system
password level. Password levels 0 and 1 allow passwords up to 10 characters
in length. Password levels 2 and 3 allow passwords up to 128 characters in
length.</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>