Platform SDK: Active Directory, ADSI, and Directory Services

ldap_delete_s

The ldap_delete_s function is a synchronous operation that removes a leaf entry from the directory tree.

ULONG ldap_delete_s(
  LDAP* ld,
  PCHAR dn
);

Parameters

ld
[in] The session handle.
dn
[in] The distinguished name of the entry to delete.

Return Values

If the function succeeds, the return value is LDAP_SUCCESS.

If the function fails, it returns an error code. See Return Values for more information.

Remarks

Call ldap_delete_s to remove a leaf entry from the directory tree. (Note that LDAP does not support deletion of entire subtrees in a single operation.) As a synchronous operation, ldap_delete_s does not return until the operation is compete. Use ldap_delete or ldap_delete_ext if you want the delete operation to be carried out asynchronously.

Multithreading: The ldap_delete_s function is thread-safe.

Note  When connecting to an LDAP 2 server, the application must perform a bind operation (by calling one of the ldap_bind or ldap_simple_bind routines) before attempting any other operations.

Requirements

  Windows NT/2000: Requires Windows NT 4.0 SP4 or later.
  Windows 95/98: Requires Windows 95 or later. Available as a redistributable for Windows 95.
  Header: Declared in Winldap.h.
  Library: Use Wldap32.lib.
  Unicode: Declared as Unicode and ANSI prototypes.

See Also

Functions, ldap_bind, ldap_delete, ldap_delete_ext, ldap_simple_bind, Modifying a Directory Entry, Return Values