ldap_mods_free()--Free LDAP Modify Storage

Syntax

 #include <ldap.h>

 void ldap_mods_free(
                LDAPMod  **mods,
                int        freemods)

  Default Public Authority: *USE

  Library Name/Service Program: QSYS/QGLDCLNT

  Threadsafe: Yes

The ldap_mods_free() function is used to free storage associated with the ldap_modify() and related LDAP APIs.

ldap_mods_free() can be used to free each element of a NULL-terminated array of modification structures. If freemods is nonzero, the mods pointer itself is freed, otherwise freeing mods is left to the caller.

Authorities and Locks

No IBM^® i authority is required.

Parameters

mods: (Input) Specifies a NULL-terminated array of modifications to make to the entry. Each element of the mods array is a pointer to an LDAPMod structure.
freemods: (Input) Specifies whether or not the mods pointer is to be freed in addition to the NULL-terminated array of LDAPMod structures.

Return Value

None.

Error Conditions

The ldap_mods_free() API does not return an error code.

Error Messages

The following message may be sent from this function.

Message ID	Error Message Text
CPF3CF2 E	Error(s) occurred during running of ldap_mods_free API.

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_mods_free() -- Free an array of pointers to mod structures.
ldap_memfree() -- Free storage allocated by the LDAP client library.
ldap_modify() -- Perform an LDAP modify entry request.
ldap_msgfree() -- Free the LDAPMessage structure.
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

API introduced: V4R3

[ Back to top | LDAP APIs | APIs by category ]