<!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_msgfree()--Free LDAP Result Message</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_msgfree()--Free LDAP Result Message</h2> <br> <div class="box" style="width: 60%;"> <br> Syntax<br> <pre> #include <ldap.h> int ldap_msgfree( LDAPMessage *<em>msg</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_msgfree()</strong> routine is used to free the memory allocated for an LDAP message by <a href="ldap_result.htm">ldap_result()</a>, <a href="ldap_search_s.htm">ldap_search_s()</a>, <a href= "ldap_search_ext_s.htm">ldap_search_ext_s()</a> or <a href= "ldap_search_st.htm">ldap_search_st()</a>. It takes a pointer to the result to be freed and returns the type of the message it freed.</p> <br> <h3>Authorities and Locks</h3> <p>No i5/OS authority is required.</p> <br> <h3>Parameters</h3> <dl> <dt><em>msg</em></dt> <dd>(Input) Specifies pointer to the memory allocated for an LDAP message by <a href="ldap_result.htm">ldap_result()</a>, <a href="ldap_search_s.htm"> ldap_search_s()</a>, <a href="ldap_search_ext_s.htm">ldap_search_ext_s()</a> or <a href="ldap_search_st.htm">ldap_search_st()</a>.</dd> </dl> <br> <h3>Return Values</h3> <dl> <dt><strong>Message Type</strong></dt> <dd>the type of the message freed.<br> <br> </dd> <dt><strong>ZERO</strong></dt> <dd>if the input pointer to LDAPMessage structure is NULL.</dd> </dl> <br> <h3>Error Conditions</h3> <p>The <strong>ldap_msgfree()</strong> API returns ZERO if the input pointer to LDAPMessage structure is NULL.</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_msgfree 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_memfree.htm">ldap_memfree()</a> -- Free storage allocated by the LDAP client library.</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_result.htm">ldap_result</a> -- Retrieve result of an asynchronous LDAP operation.</li> <li><a href="ldap_search_ext_s.htm">ldap_search_ext_s</a> -- Synchronously search the directory using controls.</li> <li><a href="ldap_search_s.htm">ldap_search_s</a> -- Perform an LDAP search operation (synchronous).</li> <li><a href="ldap_search_st.htm">ldap_search_st</a> -- Perform an LDAP search operation (timed synchronous).</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> <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>