ldap_msgfree()--Free LDAP Result Message

 #include <ldap.h>

 int ldap_msgfree(
          LDAPMessage  *msg)

The ldap_msgfree() routine is used to free the memory allocated for an LDAP message by ldap_result(), ldap_search_s(), ldap_search_ext_s() or ldap_search_st(). It takes a pointer to the result to be freed and returns the type of the message it freed.

Authorities and Locks

No i5/OS authority is required.

Parameters

msg

(Input) Specifies pointer to the memory allocated for an LDAP message by ldap_result(), ldap_search_s(), ldap_search_ext_s() or ldap_search_st().

Return Values

Message Type

the type of the message freed.

ZERO

if the input pointer to LDAPMessage structure is NULL.

Error Conditions

The ldap_msgfree() API returns ZERO if the input pointer to LDAPMessage structure is NULL.

Error Messages

The following message may be sent from this function.

Related Information

• ldap_ber_free() -- Free the BerElement structure.
• ldap_control_free() -- Free a single LDAPControl structure.
• ldap_controls_free() -- Free an array of LDAPControl structures.
• ldap_free_urldesc -- Free an LDAP URL Description
• ldap_memfree() -- Free storage allocated by the LDAP client library.
• ldap_mods_free() -- Free an array of pointers to mod structures.
• ldap_result -- Retrieve result of an asynchronous LDAP operation.
• ldap_search_ext_s -- Synchronously search the directory using controls.
• ldap_search_s -- Perform an LDAP search operation (synchronous).
• ldap_search_st -- Perform an LDAP search operation (timed synchronous).
• ldap_server_free_list -- Free the List of LDAP Servers
• ldap_value_free -- Free memory allocated by ldap_get_values
• ldap_value_free_len -- Free Memory Allocated by ldap_get_values_len