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

114 lines
6.4 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_GetPasswordExpireDate" />
<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_getpasswordexpiredate" />
<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_GetPasswordExpireDate</title>
</head>
<body id="cwbco_getpasswordexpiredate"><a name="cwbco_getpasswordexpiredate"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1"><span class="apiname">cwbCO_GetPasswordExpireDate</span></h1>
<div><div class="section"><h4 class="sectiontitle">Purpose</h4><p>Retrieves the date and time the password
will expire for the user ID that is set in the given system object on the iSeries™ system
that it represents.</p>
</div>
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>
UINT CWB_ENTRY cwbCO_GetPasswordExpireDate(
cwbCO_SysHandle system,
cwb_DateTime *expirationDateTime);</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">cwb_DateTime * expirationDateTime - output</dt>
<dd>A pointer to a structure that contains the date and time at which the
password will expire for the current user ID, in the following format:
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" width="90%" frame="border" border="1" rules="all"><thead align="left"><tr><th align="left" valign="bottom" width="20%" id="d0e55">Bytes</th>
<th align="left" valign="bottom" width="80%" id="d0e57">Content</th>
</tr>
</thead>
<tbody><tr><td align="left" valign="top" width="20%" headers="d0e55 ">1 - 2</td>
<td align="left" valign="top" width="80%" headers="d0e57 ">Year (Example: 1998 = 0x07CF)</td>
</tr>
<tr><td align="left" valign="top" width="20%" headers="d0e55 ">3</td>
<td align="left" valign="top" width="80%" headers="d0e57 ">Month (January = 0x01)</td>
</tr>
<tr><td align="left" valign="top" width="20%" headers="d0e55 ">4</td>
<td align="left" valign="top" width="80%" headers="d0e57 ">Day (First day = 0x01;31st day = 0x1F)</td>
</tr>
<tr><td align="left" valign="top" width="20%" headers="d0e55 ">5</td>
<td align="left" valign="top" width="80%" headers="d0e57 ">Hour (Midnight = 0x00;23rd hour = 0x17)</td>
</tr>
<tr><td align="left" valign="top" width="20%" headers="d0e55 ">6</td>
<td align="left" valign="top" width="80%" headers="d0e57 ">Minute (On the hour = 0x00; 59th minute =
0x3B)</td>
</tr>
<tr><td align="left" valign="top" width="20%" headers="d0e55 ">7</td>
<td align="left" valign="top" width="80%" headers="d0e57 ">Second (On the minute = 0x00; 59th second
= 0x3B)</td>
</tr>
<tr><td align="left" valign="top" width="20%" headers="d0e55 ">8</td>
<td align="left" valign="top" width="80%" headers="d0e57 ">One-hundredth of a second (on the second
= 0x00; maximum = 0x63)</td>
</tr>
</tbody>
</table>
</div>
<div class="note"><span class="notetitle">Note:</span> On a given day, the maximum time is 23 hours, 59 minutes, and
59.99 seconds. Midnight is 0 hours, 0 minutes, and 0.0 seconds on the following
day.</div>
</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>The pointer to the cwb_DateTime structure is NULL.</dd>
<dt class="dlterm">CWB_INV_BEFORE_VALIDATE</dt>
<dd>The user ID and password that were set in the specified system object
have not been validated (so the password expire date is not available), or
validation has occurred and the user profile password expiration interval
is set to *NOMAX.</dd>
</dl>
</div>
<div class="section"><h4 class="sectiontitle">Usage</h4><p>You successfully must have called <span class="apiname">cwbCO_VerifyUserIDPassword</span>, <span class="apiname">cwbCO_Signon</span>,
or <span class="apiname">cwbCO_Connect</span> before using this API. If you want to
ensure that the value that is returned is recent, you either must call <span class="apiname">cwbCO_VerifyUserIDPassword</span> explicitly,
or set the Validate Mode to CWBCO_VALIDATE_ALWAYS before you call <span class="apiname">cwbCO_Signon</span> or <span class="apiname">cwbCO_Connect</span>.</p>
<p>If
the user profile password expiration interval is set to *NOMAX, a password
expire date does not exist. To detect this case, first validate the user
ID and password as noted above, and then, if successful, call <span class="apiname">cwbCO_GetPasswordExpireDate</span>.
A return code of CWBCO_INV_BEFORE_VALIDATE means that the password expiration
interval is set to *NOMAX.</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>