Merge branch 'mdb.master' of /home/hyc/OD/mdb

[openldap] / doc / man / man3 / ldap_abandon.3

diff --git a/doc/man/man3/ldap_abandon.3 b/doc/man/man3/ldap_abandon.3
index dc70df2b92610d78899ca9b7f9999ec2d33ce6f0..1f71df5aae2cd4a2e5500f3f706283fef6399c3e 100644 (file)
--- a/doc/man/man3/ldap_abandon.3
+++ b/doc/man/man3/ldap_abandon.3
@@ -1,49 +1,69 @@
-.TH LDAP_ABANDON 3 "22 September 1998" "OpenLDAP LDVERSION"
+.TH LDAP_ABANDON 3 "RELEASEDATE" "OpenLDAP LDVERSION"

 .\" $OpenLDAP$
 .\" $OpenLDAP$

-.\" Copyright 1998-2002 The OpenLDAP Foundation All Rights Reserved.
+.\" Copyright 1998-2011 The OpenLDAP Foundation All Rights Reserved.

 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
 .SH NAME
 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
 .SH NAME

-ldap_abandon \- Abandon an LDAP operation in progress
+ldap_abandon_ext \- Abandon an LDAP operation in progress
+.SH LIBRARY
+OpenLDAP LDAP (libldap, \-lldap)

 .SH SYNOPSIS
 .nf
 .SH SYNOPSIS
 .nf

-.ft B
+.B

 #include <ldap.h>
 .LP
 .ft B
 #include <ldap.h>
 .LP
 .ft B

-int ldap_abandon(ld, msgid)
-.ft
-LDAP *ld;
-int msgid;
+int ldap_abandon_ext(
+.RS
+.ft B
+LDAP *\fIld\fB,
+Bint \fImsgid\fB,
+LDAPControl **\fIsctrls\fB,
+LDAPControl **\fIcctrls\fB );
+.RE
+.fi

 .SH DESCRIPTION
 The
 .SH DESCRIPTION
 The

-.B ldap_abandon()
-routine is used to abandon or cancel an LDAP
+.B ldap_abandon_ext()
+routine is used to send a LDAP Abandon request for an

 operation in progress.  The \fImsgid\fP passed should be the
 operation in progress.  The \fImsgid\fP passed should be the

-message id of an outstanding LDAP operation, as returned by
-.BR ldap_search (3),
-.BR ldap_modify (3),
-etc.
+message id of an outstanding LDAP operation, such as returned by
+.BR ldap_search_ext (3).

 .LP
 .LP

-.BR ldap_abandon ()
+.BR ldap_abandon_ext ()

 checks to see if the result of the operation has already come in.  If it
 has, it deletes it from the queue of pending messages.  If not,
 checks to see if the result of the operation has already come in.  If it
 has, it deletes it from the queue of pending messages.  If not,

-it sends an LDAP abandon operation to the the LDAP server.
+it sends an LDAP abandon request to the LDAP server.

 .LP
 The caller can expect that the result of an abandoned operation
 will not be returned from a future call to
 .BR ldap_result (3).
 .LP
 The caller can expect that the result of an abandoned operation
 will not be returned from a future call to
 .BR ldap_result (3).

-.SH ERRORS
-.B ldap_abandon()
-returns 0 if everything goes ok, -1 otherwise,
-setting \fIld_errno\fP appropriately. See
+.LP
+.B ldap_abandon_ext()
+allows server and client controls to be passed in via the
+.I sctrls
+and
+.I cctrls
+parameters, respectively.
+.LP
+.B ldap_abandon_ext()
+returns a code indicating success or, in the case of failure, the
+nature of the failure.  See

 .BR ldap_error (3)
 for details.
 .BR ldap_error (3)
 for details.

+.SH DEPRECATED INTERFACES
+The
+.B ldap_abandon()
+routine is deprecated in favor of the
+.B ldap_abandon_ext()
+routine. 
+.LP
+.so Deprecated
+

 .SH SEE ALSO
 .SH SEE ALSO

-.BR ldap(3),
-.BR ldap_result(3),
-.B ldap_error(3)
+.BR ldap (3),
+.BR ldap_error (3),
+.BR ldap_result (3),
+.BR ldap_search_ext (3)

 .SH ACKNOWLEDGEMENTS
 .SH ACKNOWLEDGEMENTS

-.B     OpenLDAP
-is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
-.B     OpenLDAP
-is derived from University of Michigan LDAP 3.3 Release.  
+.so ../Project
+