openldap/doc/man/man3/ldap_delete.3

90 lines
2.2 KiB
Groff
Raw Normal View History

2002-06-13 11:59:10 +08:00
.TH LDAP_DELETE 3 "RELEASEDATE" "OpenLDAP LDVERSION"
1999-09-12 12:41:47 +08:00
.\" $OpenLDAP$
2020-01-10 00:50:21 +08:00
.\" Copyright 1998-2020 The OpenLDAP Foundation All Rights Reserved.
1999-09-12 12:41:47 +08:00
.\" Copying restrictions apply. See COPYRIGHT/LICENSE.
1998-08-09 08:43:13 +08:00
.SH NAME
2006-02-02 17:47:14 +08:00
ldap_delete, ldap_delete_s, ldap_delete_ext, ldap_delete_ext_s \- Perform an LDAP delete operation.
2002-06-21 15:32:54 +08:00
.SH LIBRARY
2009-06-03 08:43:44 +08:00
OpenLDAP LDAP (libldap, \-lldap)
1998-08-09 08:43:13 +08:00
.SH SYNOPSIS
.nf
.ft B
#include <ldap.h>
.LP
.ft B
int ldap_delete_s(ld, dn)
.ft
LDAP *ld;
char *dn;
.LP
.ft B
int ldap_delete(ld, dn)
.ft
LDAP *ld;
char *dn;
2006-02-02 17:47:14 +08:00
.LP
.ft B
int ldap_delete_ext(ld, dn, serverctrls, clientctrls, msgidp)
.ft
LDAP *ld;
char *dn;
LDAPControl **serverctrls, **clientctrls;
int *msgidp;
.LP
.ft B
int ldap_delete_ext_s(ld, dn, serverctrls, clientctrls)
.ft
LDAP *ld;
char *dn;
LDAPControl **serverctrls, **clientctrls;
1998-08-09 08:43:13 +08:00
.SH DESCRIPTION
The
.B ldap_delete_s()
routine is used to perform an LDAP delete operation
2006-02-02 17:47:14 +08:00
synchronously. It takes \fIdn\fP, the DN of the entry to be deleted.
1998-08-09 08:43:13 +08:00
It returns an LDAP error code, indicating the success or failure of the
operation.
.LP
The
.B ldap_delete()
routine is used to perform an LDAP delete operation
2006-02-02 17:47:14 +08:00
asynchronously. It takes the same parameters as
.BR ldap_delete_s(),
but returns the message id of the request it initiated. The result of
1998-08-09 08:43:13 +08:00
the delete can be obtained by a subsequent call to
.BR ldap_result (3).
2006-02-02 17:47:14 +08:00
.LP
The
.B ldap_delete_ext()
routine allows server and client controls to be
specified to extend the delete request. This routine is asynchronous like
ldap_delete(), but its return value is an LDAP error code. It stores the
message id of the request in the integer pointed to by msgidp.
.LP
The
.B ldap_delete_ext_s()
routine is the synchronous version of
.BR ldap_delete_ext().
It also returns an LDAP error code indicating success
or failure of the operation.
1998-08-09 08:43:13 +08:00
.SH ERRORS
.B ldap_delete_s()
returns an LDAP error code which can be interpreted
by calling one of
.BR ldap_perror (3)
and friends.
.B ldap_delete()
2009-06-03 08:43:44 +08:00
returns \-1 if something went wrong initiating the request. It returns the
1998-08-09 08:43:13 +08:00
non-negative message id of the request if things went ok.
2006-02-02 17:47:14 +08:00
.LP
.B ldap_delete_ext()
and
.B ldap_delete_ext_s()
return some Non-zero value if
something went wrong initiating the request, else return 0.
1998-08-09 08:43:13 +08:00
.SH SEE ALSO
.BR ldap (3),
.BR ldap_error (3)
1998-10-25 09:41:42 +08:00
.SH ACKNOWLEDGEMENTS
.so ../Project