mirror/openldap
2
0
Fork 0
mirror of https://git.openldap.org/openldap/openldap.git synced 2024-12-21 03:10:25 +08:00
Code Issues Packages Projects Releases Wiki Activity

ldap_delete_ext, ldap_delete_ext_s

Browse Source
This commit is contained in:
Anil Kumar Kommuri 2006-02-02 09:47:14 +00:00
parent 4dcad2637c
commit 0da8dbde40
1 changed files with 41 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
doc/man/man3/ldap_delete.3
View File

@ -3,7 +3,7 @@
.\" Copyright 1998-2006 The OpenLDAP Foundation All Rights Reserved. .\" Copyright 1998-2006 The OpenLDAP Foundation All Rights Reserved.
.\" Copying restrictions apply. See COPYRIGHT/LICENSE. .\" Copying restrictions apply. See COPYRIGHT/LICENSE.
.SH NAME .SH NAME
ldap_delete, ldap_delete_s \- Perform an LDAP delete operation ldap_delete, ldap_delete_s, ldap_delete_ext, ldap_delete_ext_s \- Perform an LDAP delete operation.
.SH LIBRARY .SH LIBRARY
OpenLDAP LDAP (libldap, -lldap) OpenLDAP LDAP (libldap, -lldap)
.SH SYNOPSIS .SH SYNOPSIS
@ -22,22 +22,51 @@ int ldap_delete(ld, dn)
.ft .ft
LDAP *ld; LDAP *ld;
char *dn; char *dn;
.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;
.SH DESCRIPTION .SH DESCRIPTION
The The
.B ldap_delete_s() .B ldap_delete_s()
routine is used to perform an LDAP delete operation routine is used to perform an LDAP delete operation
synchronously. It takes \fIdn\fP, the DN of the entry to be deleted. synchronously. It takes \fIdn\fP, the DN of the entry to be deleted.
It returns an LDAP error code, indicating the success or failure of the It returns an LDAP error code, indicating the success or failure of the
operation. operation.
.LP .LP
The The
.B ldap_delete() .B ldap_delete()
routine is used to perform an LDAP delete operation routine is used to perform an LDAP delete operation
asynchronously. It takes the same parameters as asynchronously. It takes the same parameters as
.BR ldap_delete_s() , .BR ldap_delete_s(),
but returns the message id of the request it initiated. The result of but returns the message id of the request it initiated. The result of
the delete can be obtained by a subsequent call to the delete can be obtained by a subsequent call to
.BR ldap_result (3). .BR ldap_result (3).
.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.
.SH ERRORS .SH ERRORS
.B ldap_delete_s() .B ldap_delete_s()
returns an LDAP error code which can be interpreted returns an LDAP error code which can be interpreted
@ -45,8 +74,14 @@ by calling one of
.BR ldap_perror (3) .BR ldap_perror (3)
and friends. and friends.
.B ldap_delete() .B ldap_delete()
returns -1 if something went wrong initiating the request. It returns the returns -1 if something went wrong initiating the request. It returns the
non-negative message id of the request if things went ok. non-negative message id of the request if things went ok.
.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.
.SH SEE ALSO .SH SEE ALSO
.BR ldap (3), .BR ldap (3),
.BR ldap_error (3) .BR ldap_error (3)