187 lines
5.3 KiB
HTML
187 lines
5.3 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_unbind_ext()--Perform an LDAP Unbind Request</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/20/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_unbind_ext()--Perform an LDAP Unbind Request</h2>
|
|
|
|
<div class="box" style="width: 70%;">
|
|
<br>
|
|
Syntax<br>
|
|
<pre>
|
|
#include <ldap.h>
|
|
|
|
int ldap_unbind_ext(
|
|
LDAP *<em>ld</em>,
|
|
LDAPControl **<em>servctrls</em>,
|
|
LDAPControl **<em>clientctrls</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_unbind_ext()</strong> function is used to end the
|
|
connection to the LDAP server and free the resources contained in the <em>
|
|
ld</em> structure.</p>
|
|
|
|
<p>Once it is called, any open connection associated with the LDAP session
|
|
handle, <em>ld</em>, to the LDAP server is closed, and any resources associated
|
|
with the handle are disposed of before returning. The <em>ld</em> structure is
|
|
invalid and cannot be used for any further api calls. The <strong>
|
|
ldap_unbind_ext()</strong> is synchronous and allows server and client controls
|
|
to be included. Note that since there is no server response to an unbind there
|
|
is no way to receive a response to a server control sent with an <strong>
|
|
ldap_unbind_ext()</strong>.</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>serverctrls</em></dt>
|
|
|
|
<dd>(Input) Specifies a list of LDAP server controls. This parameter may be set
|
|
to null. See <a href="ldap_controls.htm">LDAP Controls</a> for more information
|
|
about server controls.</dd>
|
|
|
|
<dt><em>clientctrls</em></dt>
|
|
|
|
<dd>(Input) Specifies a list of LDAP client controls. This parameter may be set
|
|
to null. See <a href="ldap_controls.htm">LDAP Controls</a> for more information
|
|
about client controls.</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Return Value</h3>
|
|
|
|
<dl>
|
|
<dt><strong>LDAP_SUCCESS</strong></dt>
|
|
|
|
<dd>if the request was successful.<br>
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>LDAP error</strong></dt>
|
|
|
|
<dd>if the request was not successful.</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Error Conditions</h3>
|
|
|
|
<p>If <strong>ldap_unbind_ext()</strong> is not successful, it returns an LDAP
|
|
error code other than LDAP_SUCCESS. See <a href="ldap_error_condt.htm">LDAP
|
|
Client API Error Conditions</a> for possible LDAP error code values.</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_unbind_ext API.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3>Related Information</h3>
|
|
|
|
<ul>
|
|
<li><a href="ldap_bind.htm">ldap_bind()</a> -- Asynchronously bind to the
|
|
directory (deprecated).</li>
|
|
|
|
<li><a href="ldap_bind_s.htm">ldap_bind_s()</a> -- Synchronously 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><a href="ldap_sasl_bind_s.htm">ldap_sasl_bind_s()</a> -- Synchronously bind
|
|
to the directory using SASL.</li>
|
|
|
|
<li><a href="ldap_simple_bind.htm">ldap_simple_bind()</a> -- Asynchronously
|
|
bind to the directory using simple authentication.</li>
|
|
|
|
<li><a href="ldap_simple_bind_s.htm">ldap_simple_bind_s()</a> -- Synchronously
|
|
bind to the directory using simple authentication.</li>
|
|
|
|
<li><a href="ldap_unbind_s.htm">ldap_unbind_s()</a> -- Synchronously unbind
|
|
from the LDAP server and close the connection.</li>
|
|
</ul>
|
|
|
|
<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>
|
|
|