ldap_delete_ext_s function (winldap.h)

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

Syntax

WINLDAPAPI ULONG LDAPAPI ldap_delete_ext_s(
  [in] LDAP          *ld,
  [in] const PSTR    dn,
  [in] PLDAPControlA *ServerControls,
  [in] PLDAPControlA *ClientControls
);

Parameters

[in] ld

The session handle.

[in] dn

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

[in] ServerControls

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

[in] ClientControls

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

Return value

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

See also

Extended Controls

Functions

Modifying a Directory Entry

Return Values

Using Controls

ldap_delete

ldap_delete_ext

ldap_delete_s