ldap_controls_free function (winldap.h)

Article
09/22/2022

The ldap_controls_free function frees an array of LDAPControl structures.

Syntax

WINLDAPAPI ULONG LDAPAPI ldap_controls_free(
  [in] LDAPControlA **Controls
);

Parameters

[in] Controls

The array of LDAPControl structures to free.

Return value

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

Requirement	Value
Minimum supported client	Windows Vista
Minimum supported server	Windows Server 2008
Target Platform	Windows
Header	winldap.h
Library	Wldap32.lib
DLL	Wldap32.dll