Export (0) Print
Expand All
Expand Minimize
This topic has not yet been rated - Rate this topic

ldap_delete_s function

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

Syntax


ULONG ldap_delete_s(
  _In_  LDAP *ld,
  _In_  PCHAR dn
);

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.

Return value

If the function succeeds, the return value is LDAP_SUCCESS.

If the function fails, it returns an error code. For more information, see Return Values.

Remarks

Call ldap_delete_s to remove a leaf entry from the directory tree. Be aware 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 to perform the delete operation 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

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Winldap.h

Library

Wldap32.lib

DLL

Wldap32.dll

Unicode and ANSI names

ldap_delete_sW (Unicode) and ldap_delete_sA (ANSI)

See also

Functions
ldap_bind
ldap_delete
ldap_delete_ext
ldap_simple_bind
Modifying a Directory Entry
Return Values

 

 

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.