ldap_delete_s()--Perform an LDAP Delete Operation (Synchronous)

Syntax

#include <ldap.h>
 
int ldap_delete_s(
   LDAP           *ld,
   const char     *dn)

  Default Public Authority: *USE

  Library Name/Service Program: QSYS/QGLDCLNT

  Threadsafe: Yes

The ldap_delete_s() routine initiates a synchronous LDAP operation to delete a leaf entry.

Note that the entry to delete must be a leaf entry (that is, it must have no children). Deletion of entire subtrees in a single operation is not supported by LDAP.

Authorities and Locks

No IBM^® i authority is required. All authority checking is done by the LDAP server.

Parameters

ld: (Input) Specifies the LDAP pointer returned by a previous call to ldap_init(), ldap_ssl_init(), or ldap_open().
dn: (Input) Specifies the Distinguished Name (DN) of the entry to be deleted.

Return Value

LDAP_SUCCESS: if the request was successful.
another LDAP error code: if the request was not successful.

Error Conditions

The ldap_delete_s() will return an LDAP error code if not successful. See LDAP Client API Error Conditions for possible LDAP error code values.

Error Messages

The following message may be sent from this function.

Message ID	Error Message Text
CPF3CF2 E	Error(s) occurred during running of ldap_delete_s API.

Related Information

ldap_delete() -- Asynchronous delete an entry.
ldap_delete_ext() -- Asynchronous delete an entry with controls.
ldap_delete_ext_s() -- Synchronous delete an entry with controls.

API introduced: V4R3

[ Back to top | LDAP APIs | APIs by category ]