ldap_delete_ext_s()--Perform an LDAP Delete Operation with Controls

 #include <ldap.h>
 
 int ldap_delete_ext_s(LDAP           *ld,
                      const char     *dn,
                      LDAPControl    **serverctrls,
                      LDAPControl    **clientctrls)

The ldap_delete_ext_s() routine initiates a synchronous LDAP operation to delete a leaf entry with controls.

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.

serverctrls

(Input) Specifies a list of LDAP server controls. This parameter may be set to null. See Controls for LDAP APIs for more information about server controls.

clientctrls

(Input) Specifies a list of LDAP client controls. This parameter may be set to null. See Controls for LDAP APIs for more information about client controls.

Return Value

LDAP_SUCCESS

if the request was successful.

another LDAP error code

if the request was not successful.

Error Conditions

The ldap_delete_ext_s() API 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.

Related Information

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

The ldap_delete_ext_s() API supports LDAP V3 server controls and client controls.

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