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

160 lines
3.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_memfree()--Free Memory Allocated by LDAP API</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 type="text/javascript" language="Javascript" src="../rzahg/synch.js">
</script>
<a name="Top_Of_Page"></a>
<h2>ldap_memfree()--Free Memory Allocated by LDAP API</h2>
<div class="box" style="width: 70%;">
<br>
&nbsp;&nbsp;Syntax<br>
<pre>
#include &lt;ldap.h&gt;
void ldap_memfree(
char *<em>mem</em>)
</pre>
<br>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Library Name/Service Program: QSYS/QGLDCLNT<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: Yes<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The <strong>ldap_memfree()</strong> API is used to free storage that is
allocated by some of the LDAP APIs. Refer to the specific LDAP API
documentation to see which memory free API to use for any memory allocated.<br>
</p>
<br>
<h3>Authorities and Locks</h3>
<p>No i5/OS authority is required.</p>
<br>
<h3>Parameters</h3>
<dl>
<dt><em>mem</em></dt>
<dd>(Input) Specifies the address of storage that was allocated by the LDAP
library.</dd>
</dl>
<br>
<h3>Return Value</h3>
<dl>
<dt>NONE</dt>
</dl>
<br>
<h3>Error Conditions</h3>
<p>The <strong>ldap_memfree()</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 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_memfree
API.</td>
</tr>
</table>
<br>
<br>
<h3>Related Information</h3>
<ul>
<li><a href="ldap_ber_free.htm">ldap_ber_free()</a> -- Free the BerElement
structure.</li>
<li><a href="ldap_cntrl_free.htm">ldap_control_free()</a> -- Free a single
LDAPControl structure.</li>
<li><a href="ldap_cntrls_free.htm">ldap_controls_free()</a> -- Free an array of
LDAPControl structures.</li>
<li><a href="ldap_free_urldesc.htm">ldap_free_urldesc</a> -- Free an LDAP URL
Description</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_msgfree.htm">ldap_msgfree()</a> -- Free the LDAPMessage
structure.</li>
<li><a href="ldap_server_free_list.htm">ldap_server_free_list</a> -- Free the
List of LDAP Servers</li>
<li><a href="ldap_value_free.htm">ldap_value_free</a> -- Free memory allocated
by ldap_get_values</li>
<li><a href="ldap_value_free_len.htm">ldap_value_free_len</a> -- Free Memory
Allocated by ldap_get_values_len</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>