Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

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_RETCODEenumeration 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_bindto 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_unbindand 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 LDAPstructure after it has been freed.

Requirements

Header winldap.h
Library wldap32.lib
Windows Embedded CE Windows CE .NET 4.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also