Directory Services

ldap_unbind_s

The ldap_unbind_s function frees resources associated with an LDAP session.

ULONG ldap_unbind_s(
  LDAP* ld
);

Parameters

ld
[in] The session handle.

Return Values

If the function succeeds, the return value is LDAP_SUCCESS.

If the function fails, it returns an error code. For more information, see Return Values.

Remarks

Call ldap_unbind_s to unbind from the directory, close the connection, and dispose of the session handle. Call this function when you have finished with an LDAP connection structure, even if you have not called ldap_bind when opening the connection. Ensure 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 ldap_unbind_s work synchronously. There is no server response to an unbind operation.

Multithreading: Calls to ldap_unbind_s are safe except that you cannot use the session handle to the LDAP structure after it has been freed.

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.
Header: Declared in Winldap.h.
Library: Use Wldap32.lib.

See Also

Functions, LDAP, ldap_bind, ldap_unbind, Return Values