ldap_delete_ext_s

The ldap_delete_ext_s function is an extended routine that performs a synchronous operation to remove a leaf entry from the directory tree.

ULONG ldap_delete_ext_s(
  LDAP* ld,
  PCHAR dn,
  PLDAPControl* ServerControls,
  PLDAPControl* ClientControls
);

Parameters

ld

[in] The session handle.

dn

[in] A pointer to a null-terminated string that contains the distinguished name of the entry to delete.

ServerControls

[in] Optional. List of LDAP server controls. Set this parameter to NULL if not used.

ClientControls

[in] Optional. List of client controls. Set this parameter to NULL if not used.

Return Values

If the function succeeds, LDAP_SUCCESS is returned.

If the function fails, an error code is returned. For more information, see Return Values.

Remarks

Call ldap_delete_ext_s to remove a leaf entry from the directory tree. LDAP does not support deletion of entire subtrees in a single operation, however there is an extended control, LDAP_SERVER_TREE_DELETE_OID, that does provide this. The parameters and effects of ldap_delete_ext_s include those of ldap_delete_s. The extended routine includes additional parameters to support client and server controls and thread safety.

As a synchronous function, ldap_delete_ext_s returns when the delete operation is complete. Use ldap_delete or ldap_delete_ext to have the delete operation performed asynchronously.

Multithreading: Calls to ldap_delete_ext_s are thread-safe.

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.
Unicode: Implemented as Unicode and ANSI versions on all platforms.
Header: Declared in Winldap.h.
Library: Use Wldap32.lib.

See Also

Extended Controls, Using Controls, Functions, ldap_delete, ldap_delete_ext, ldap_delete_s, Modifying a Directory Entry, Return Values