Share via

ldap_unbind_s (Compact 2013)

  • Article

3/26/2014

This function frees all resources associated with an LDAP session.

Syntax

ULONG ldap_unbind_s(
  LDAP *ld
);

Parameters

  • ld
    [in] Session handle.

Return Value

If this function succeeds, the return value is LDAP_SUCCESS.

If this function fails, it returns an error code. See the LDAP_RETCODE enumeration for a list of possible return values.

Remarks

Call this function to unbind from the directory, close the connection, and dispose of the session handle. Call this function whenever you have finished with a connection, even if you have not called ldap_bind to open the connection. Make sure that you do not inadvertently call this function more than once on a session handle because doing so can free resources that you did not intend to release.

Both ldap_unbind and this function work synchronously. There is no server response to an unbind operation.

In a multithreading environment, calls to this function are safe, but you cannot use the session handle to the LDAP structure after it has been freed.

Requirements

Header

winldap.h

Library

wldap32.lib

See Also

Reference

LDAP Session Functions
LDAP_RETCODE
LDAP
ldap_bind
ldap_unbind