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

149 lines
3.7 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_controls_free()--Free storage allocated by the LDAP library</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 -->
<!-- This file has undergone html cleanup on 2/18/02 by JET -->
<!--File Edited March 2001 -->
<!--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_controls_free()--Free storage allocated by the LDAP library</h2>
<div class="box" style="width: 70%;">
<br>
&nbsp;&nbsp;Syntax<br>
<pre>
#include &lt;ldap.h&gt;
void ldap_controls_free(LDAPControl **<em>ctrls</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_controls_free()</strong> routine is used to free storage
allocated by the LDAP APIs that uses an array of LDAPControl structure.</p>
<br>
<h3>Authorities and Locks</h3>
<p>No i5/OS authority is required.</p>
<br>
<h3>Parameters</h3>
<dl>
<dt><strong><em>ctrls</em></strong></dt>
<dd>(Input) The address of an LDAPControl list, represented as a
NULL-terminated array of pointers to LDAPControl structures.</dd>
</dl>
<br>
<h3>Return Value</h3>
<p>None.</p>
<br>
<h3>Error Conditions</h3>
<p>The <strong>ldap_controls_free()</strong> API does not return an error
code.</p>
<br>
<h3>Error Messages</h3>
<p>The following message may be sent from this function.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<th align="left" valign="top">Message ID</th>
<th align="left" valign="top">Error Message Text</th>
</tr>
<tr>
<td align="left" valign="top">CPF3CF2 E</td>
<td align="left" valign="top">Error(s) occurred during running of
ldap_controls_free API.</td>
</tr>
</table>
<br>
<br>
<h3>Related Information</h3>
<ul>
<li><a href="ldap_ber_free.htm">ldap_ber_free()</a> -- Free storage allocatd
for BerElement structure.</li>
<li><a href="ldap_memfree.htm">ldap_memfree()</a> -- Free storage that has
been allocated by the LDAP client library.</li>
<li><a href="ldap_cntrl_free.htm">ldap_control_free()</a> -- Free a single
LDAPControl structure.</li>
<li><a href="ldap_msgfree.htm">ldap_msgfree()</a> -- Free LDAP Result Message.</li>
<li><a href="ldap_mods_free.htm">ldap_mods_free()</a> -- Free an array of
pointers to mod structures.</li>
<li><a href="ldap_parse_result.htm">ldap_parse_result()</a> -- Extract
Information from Results</li>
</ul>
<br>
<hr>
API introduced: V4R5
<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>