Go to main content

man pages section 3: Networking Library Functions

Exit Print View

Updated: July 2017
 
 

ldap_delete_s(3LDAP)

Name

ldap_delete, ldap_delete_s, ldap_delete_ext, ldap_delete_ext_s - LDAP delete operation

Synopsis

cc[ flag... ] file... -lldap[ library... ]
#include <lber.h>
#include <ldap.h>

int ldap_delete(LDAP *ld, char *dn);
int ldap_delete_s(LDAP *ld, char *dn);
int ldap_delete_ext(LDAP *ld, char *dn, LDAPControl **serverctrls,
     LDAPControl **clientctrls, int *msgidp);
int ldap_delete_ext_s(LDAP *ld, char *dn, LDAPControl **serverctrls,
     LDAPControl **clientctrls);

Description

The ldap_delete_s() function is used to perform an LDAP delete operation synchronously. It takes dn, the DN of the entry to be deleted. It returns an LDAP error code, indicating the success or failure of the operation.

The ldap_delete() function is used to perform an LDAP delete operation asynchronously. It takes the same parameters as ldap_delete_s(), but returns the message id of the request it initiated. The result of the delete can be obtained by a subsequent call to ldap_result(3LDAP).

The ldap_delete_ext() function initiates an asynchronous delete operation and returns LDAP_SUCCESS if the request was successfully sent to the server, or else it returns a LDAP error code if not (see ldap_error(3LDAP)). If successful, ldap_delete_ext() places the message id of the request in *msgidp. A subsequent call to ldap_result(), can be used to obtain the result of the add request.

The ldap_delete_ext_s() function initiates a synchronous delete operation and as such returns the result of the operation itself.

Errors

ldap_delete_s() returns an LDAP error code which can be interpreted by calling one of ldap_perror(3LDAP) functions. ldap_delete () returns −1 if something went wrong initiating the request. It returns the non-negative message id of the request if things were successful.

Attributes

See attributes(5) for a description of the following attributes:

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Availability
system/library
Interface Stability
Committed

See Also

ldap(3LDAP), ldap_error(3LDAP), attributes(5)