170 lines
4.5 KiB
HTML
170 lines
4.5 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_result2error()--Retrieve LDAP 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 April 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_result2error()--Retrieve LDAP Error Information</h2>
|
|
|
|
<br>
|
|
<div class="box" style="width: 70%;">
|
|
<br>
|
|
Syntax<br>
|
|
<pre>
|
|
#include <ldap.h>
|
|
|
|
int ldap_result2error(
|
|
LDAP *<em>ld</em>,
|
|
LDAPMessage *<em>res</em>,
|
|
int <em>freeit</em>)
|
|
</pre>
|
|
|
|
<br>
|
|
Default Public Authority: *USE<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Library Name/Service Program: QSYS/QGLDCLNT<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Threadsafe: Yes<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
</div>
|
|
|
|
<p>The <strong>ldap_result2error()</strong> API takes a result as produced by
|
|
<a href="ldap_result.htm">ldap_result()</a> or <a href="ldap_search_s.htm">
|
|
ldap_search_s()</a>, and returns the corresponding error code.</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>.</dd>
|
|
|
|
<dt><em>res</em></dt>
|
|
|
|
<dd>(Input/Output) Specifies the result, as produced by <a href=
|
|
"ldap_result.htm">ldap_result()</a>, to be converted to the error code with
|
|
which it is associated.</dd>
|
|
|
|
<dt><em>freeit</em></dt>
|
|
|
|
<dd>(Input) Specifies whether or not the result, <em>res</em>, should be freed
|
|
as a result of calling <strong>ldap_result2error()</strong>. If non-zero, the
|
|
result, <em>res</em>, will be freed by the call. If zero, <em>res</em> will not
|
|
be freed by the call.</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Return Value</h3>
|
|
|
|
<dl>
|
|
<dt><strong>LDAP error code</strong></dt>
|
|
|
|
<dd>The result of the ldap request in <em>res</em>.</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Error Conditions</h3>
|
|
|
|
<p>The <strong>ldap_result2error()</strong> function will return an LDAP error
|
|
code. See <a href="ldap_error_condt.htm">LDAP Client API Error Conditions</a>
|
|
for possible LDAP error codes.</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_result2error 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> -- Retrieve error
|
|
information.</li>
|
|
|
|
<li><a href="ldap_perror.htm">ldap_perror()</a> -- Print an LDAP error
|
|
indication to standard error.</li>
|
|
|
|
<li><a href="ldap_result.htm">ldap_result()</a> -- Retrieve result of an
|
|
asynchronous LDAP operation.</li>
|
|
|
|
<li><a href="ldap_search_s.htm">ldap_search_s()</a> -- Perform an LDAP search
|
|
operation (synchronous).</li>
|
|
</ul>
|
|
|
|
<br>
|
|
<hr>
|
|
API introduced: V4R3
|
|
|
|
<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>
|
|
|