ldap_delete_s

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

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

Syntax

ULONG ldap_delete_s(
  LDAP* ld,
  UNICODE PTCHAR dn
);

Parameters

• ld
  [in] Session handle.

• dn
  [in] Distinguished name of the entry to delete.

Return Value

If this function succeeds, the return value is LDAP_SUCCESS.

If this function fails, it returns an error code. See the LDAP_RETCODE enumeration for a list of possible return values.

Remarks

Call this function to remove a leaf entry from the directory tree.

As a synchronous operation, this function does not return until the operation is complete. Use ldap_delete or ldap_delete_ext if you want the delete operation to be carried out asynchronously.

In a multithreading environment, calls to ldap_delete_s are thread-safe.

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

See Also

Reference

LDAP_RETCODE
ldap_bind
ldap_delete
ldap_delete_ext
ldap_simple_bind