te
Copyright (C) 1990, Regents of the University of Michigan. All Rights Reserved.
Portions Copyright (C) 2002, Sun Microsystems, Inc. All Rights Reserved.
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
ldap_delete, ldap_delete_s, ldap_delete_ext, ldap_delete_ext_s - LDAP delete operation

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);

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.

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.

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

ATTRIBUTE TYPE ATTRIBUTE VALUE

Interface Stability Evolving

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