ldap_delete_ext (Compact 2013)

3/26/2014

This function is an extended routine that removes a leaf entry from the directory tree.

Syntax

ULONG ldap_delete_ext(
  LDAP* ld,
  UNICODE PTCHAR dn,
  LDAPControl** ServerControls,
  LDAPControl** ClientControls,
  ULONG* MessageNumber
);

Parameters

• ld
  [in] Session handle.

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

• ServerControls
  [in] List of LDAP server controls.

• ClientControls
  [in] List of client controls.

• MessageNumber
  [out] Message identifier for the request.

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

This function removes a leaf entry from the directory tree.

The parameters and effects of this function include those of the ldap_delete function. The extended routine includes additional parameters to support client and server controls and thread safety.

If the operation succeeds, ldap_delete_ext passes the message identifier to the caller as a parameter when the operation returns successfully. Call the ldap_result function with the message identifier to get the result of the operation.

If you prefer to have the function return the results directly, use the synchronous routine ldap_delete_ext_s.

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

Requirements

See Also

Reference

LDAP Directory Entry Functions
LDAP_RETCODE
ldap_delete
ldap_delete_ext_s
ldap_result