ldap_controls_free

The ldap_controls_free function frees an array of LDAPControl structures.

ULONG ldap_controls_free(
  LDAPControl** Controls
);

Parameters

Controls

[in] The array of LDAPControl structures to free.

Return Values

If the function succeeds, LDAP_SUCCESS is returned.

If the function fails, an error code is returned. For more information, see Return Values.

Remarks

Use this function to free an array of LDAPControl structures previously allocated by LDAP function calls, such as the array returned by ldap_parse_result.

Note  This function should only be used to free controls created internally by LDAP API functions. It is not used to free memory that is explicitly allocated by the user application.

Requirements

Client: Included in Windows XP and Windows 2000 Professional.
Server: Included in Windows Server 2003 and Windows 2000 Server.
Redistributable: Requires Active Directory Client Extension on Windows NT 4.0 SP6a and Windows 95/98/Me.
Unicode: Implemented as Unicode and ANSI versions on all platforms.
Header: Declared in Winldap.h.
Library: Use Wldap32.lib.

See Also

Functions, LDAPControl, ldap_parse_result, Return Values