ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/ldap_pwdpolicy_err2string.htm

150 lines
4.2 KiB
HTML
Raw Permalink Normal View History

2024-04-02 14:02:31 +00:00
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
<title>ldap_pwdpolicy_err2string()--Convert the Numeric LDAP Password Policy Error or Warning Code into a String</title>
<!-- Begin Header Records -->
<!-- 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. -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!-- Created for V5R3 by bethvh -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body>
<!--End Header Records -->
<!-- Java sync-link -->
<script type="text/javascript" language="Javascript" src="../rzahg/synch.js">
</script>
<a name="Top_Of_Page"></a>
<h2>ldap_pwdpolicy_err2string()--Convert the Numeric LDAP Password Policy Error or Warning Code into a String</h2>
<div class="box" style="width: 70%;">
<br>
&nbsp;&nbsp;Syntax<br>
<pre>
#include &lt;ldap.h&gt;
char *ldap_pwdpolicy_err2string(
int <em>err</em>)
</pre>
<br>
&nbsp;&nbsp;Library Name/Service Program: QSYS/QGLDCLNT<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: Yes<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The <strong>ldap_pwdpolicy_err2string()</strong> function is used to convert a numeric LDAP password policy error or warning code, as returned by <a href="ldap_parse_pwdpolicy_response.htm">ldap_parse_pwdpolicy_response()</a>, into a NULL-terminated character string that describes the error or warning. The character string is returned as static data and must not be freed by the caller.</p>
<p>The text description returned will be provided in English only.</p>
<br>
<h3>Authorities and Locks</h3>
<p>No i5/OS authority is required..</p>
<br>
<h3>Parameters</h3>
<dl>
<dt><strong><em>err</em></strong></dt>
<dd>(Input) Specifies an integer value returned from <a href="ldap_parse_pwdpolicy_response.htm">ldap_parse_pwdpolicy_response()</a> containing the password policy warning or error code.<br><br></dd>
</dl>
<br>
<h3>Return Value</h3>
<dl>
<dt><strong>LDAP error description String</strong></dt>
<dd>a textual description of the LDAP error code.</dd>
</dl>
<br>
<h3>Error Conditions</h3>
<p>The <strong>ldap_pwdpolicy_err2string()</strong> API will return "Unknown Error" if
the LDAP error code is unknown. See <a href="ldap_error_condt.htm">LDAP Client
API Error Conditions</a> for possible LDAP error codes and their
description.</p>
<br>
<h3>Error Messages</h3>
<p>The following message may be sent from this function.</p>
<table width="100%" cellpadding="3">
<tr>
<th align="left" valign="top">Message ID</th>
<th align="left" valign="top">Error Message Text</th>
</tr>
<tr>
<td width="15%" valign="top">CPF3CF2 E</td>
<td width="85%" valign="top">Error(s) occurred during running of
ldap_pwdpolicy_err2string API.</td>
</tr>
</table>
<br>
<br>
<h3>Related Information</h3>
<ul>
<li><a href="ldap_parse_pwdpolicy_response.htm">ldap_parse_pwdpolicy_response()</a> -- Obtain the LDAP Password Policy error or warning codes.</li>
<li><a href="ldap_err2string.htm">ldap_err2string()</a> -- Convert LDAP error
indication to a string.</li>
<li><a href="ldap_result.htm">ldap_result()</a> -- Retrieve result of an
asynchronous LDAP operation.</li>
<li><a href="ldap_bind.htm">ldap_bind()</a> -- Asynchronously bind to the
directory (deprecated).</li>
<li><a href="ldap_sasl_bind.htm">ldap_sasl_bind()</a> -- Asynchronously bind to
the directory using SASL.</li>
<li>ldap_err2string, ldap_result</li>
</ul>
<br>
<hr>
API introduced: V5R3
<hr>
<table align="center" cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
"dirserv1.htm">LDAP APIs</a> | <a href="aplist.htm">APIs by
category</a></td>
</tr>
</table>
</body>
</html>