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




Syntax

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




Threadsafe: Yes

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

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

Authorities and Locks

No OS/400 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 DN of the entry to be deleted.

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

clientctrls
(Input) Specifies a list of LDAP client controls. This parameter may be set to null. See LDAP Controls 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

ldap_delete_ext_s() will return 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 set from this function.
    CPF3CF2 E  Error(s) occurred during running of ldap_delete_ext_s API.

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 support LDAP V3 server controls and client controls.


Top | LDAP APIs List
APIs by category

[Information Center Home Page | Feedback ] [Legal | AS/400 Glossary]