172 lines
4.9 KiB
HTML
172 lines
4.9 KiB
HTML
|
<!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_get_lderrno()--Retrieve Error Information</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 -->
|
||
|
|
<!-- Direct1 SCRIPT J converted by B2H R4.1 (346) (CMS) by V2KEA304 -->
|
||
|
|
<!-- at RCHVMW2 on 17 Feb 1999 at 11:05:09 -->
|
||
|
|
<!-- File Edited March 2001 -->
|
||
|
|
<!-- This file has undergone html cleanup on 2/19/02 by JET -->
|
||
|
|
<!-- End Header Records -->
|
||
|
|
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<!-- Java sync-link -->
|
||
|
|
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript">
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<a name="Top_Of_Page"></a>
|
||
|
|
|
||
|
|
<h2>ldap_get_lderrno()--Retrieve Error Information</h2>
|
||
|
|
|
||
|
|
<div class="box" style="width: 70%;">
|
||
|
|
<br>
|
||
|
|
Syntax<br>
|
||
|
|
<pre>
|
||
|
|
#include <ldap.h>
|
||
|
|
|
||
|
|
int ldap_get_lderrno(
|
||
|
|
LDAP *<em>ld</em>,
|
||
|
|
char **<em>dn</em>,
|
||
|
|
char **<em>errmsg</em>)
|
||
|
|
</pre>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
Library Name/Service Program: QSYS/QGLDCLNT<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
Default Public Authority: *USE<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
Threadsafe: Yes<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<p>The <strong>ldap_get_lderrno()</strong> function retrieves information about
|
||
|
|
the most recent error that occurred for an LDAP operation. This function can be
|
||
|
|
called for any LDAP API that does not return an error.</p>
|
||
|
|
|
||
|
|
<p>When an error occurs at the LDAP server, the server returns both an LDAP
|
||
|
|
result code and a message containing any additional information about the error
|
||
|
|
from the server. If the error occurred because an entry specified by a
|
||
|
|
Distinguished Name (DN) could not be found, the server may also return the
|
||
|
|
portion of the DN that identifies an existing entry. Use <strong>
|
||
|
|
ldap_get_lderrno()</strong> to obtain both the message containing error
|
||
|
|
information and the matched DN.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Authorities and Locks</h3>
|
||
|
|
|
||
|
|
<p>No i5/OS authority is required.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Parameters</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><em>ld</em></dt>
|
||
|
|
|
||
|
|
<dd>(Input) Specifies the LDAP pointer returned by a previous call to <a href=
|
||
|
|
"ldap_init.htm">ldap_init()</a>, <a href="ldap_ssl_init.htm">
|
||
|
|
ldap_ssl_init()</a>, or <a href="ldap_open.htm">ldap_open()</a>.<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><em>dn</em></dt>
|
||
|
|
|
||
|
|
<dd>(Output) The distinguished name (DN) that identifies an existing entry,
|
||
|
|
indicating how much of the name in the request was recongnized by the server.
|
||
|
|
The DN is returned when an <strong>LDAP_NO_SUCH_OBJECT</strong> error is
|
||
|
|
returned from the server on some previous operation. The matched DN string
|
||
|
|
should be freed by calling <a href="ldap_memfree.htm">ldap_memfree()</a>.<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><em>errmsg</em></dt>
|
||
|
|
|
||
|
|
<dd>(Output) The text of the error message, as returned from the server. The
|
||
|
|
error message string should be freed by calling <a href="ldap_memfree.htm">
|
||
|
|
ldap_memfree()</a>.</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Return Value</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><strong>LDAP error code</strong></dt>
|
||
|
|
|
||
|
|
<dd>See <a href="ldap_error_condt.htm">LDAP Client API Error Conditions</a> for
|
||
|
|
possible LDAP error codes values.</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<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_get_lderrno API.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Related Information</h3>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li><a href="ldap_err2string.htm">ldap_err2string()</a> -- Convert LDAP error
|
||
|
|
indication to a string.</li>
|
||
|
|
|
||
|
|
<li><a href="ldap_get_errno.htm">ldap_get_errno()</a> -- Obtain information
|
||
|
|
from most recent error.</li>
|
||
|
|
|
||
|
|
<li><a href="ldap_perror.htm">ldap_perror()</a> -- Print an LDAP error
|
||
|
|
indication to standard error.</li>
|
||
|
|
|
||
|
|
<li><a href="ldap_result2error.htm">ldap_result2error()</a> -- Extract LDAP
|
||
|
|
error indication from LDAP result.</li>
|
||
|
|
|
||
|
|
<li><a href="ldap_set_lderrno.htm">ldap_set_lderrno()</a> -- Set Error
|
||
|
|
Information</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<hr>
|
||
|
|
API introduced: V5R1<br>
|
||
|
|
<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>
|
||
|
|
|