Index: ldap_abandon.3
===================================================================
RCS file: /repo/OpenLDAP/pkg/ldap/doc/man/man3/ldap_abandon.3,v
retrieving revision 1.17
diff -u -r1.17 ldap_abandon.3
--- ldap_abandon.3	3 Jan 2006 22:12:04 -0000	1.17
+++ ldap_abandon.3	13 Jun 2006 19:51:29 -0000
@@ -1,6 +1,7 @@
 .TH LDAP_ABANDON 3 "RELEASEDATE" "OpenLDAP LDVERSION"
 .\" $OpenLDAP: pkg/ldap/doc/man/man3/ldap_abandon.3,v 1.17 2006/01/03 22:12:04 kurt Exp $
 .\" Copyright 1998-2006 The OpenLDAP Foundation All Rights Reserved.
+.\" Portions Copyright 2006 Red Hat Inc. All Rights Reserved.
 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
 .SH NAME
 ldap_abandon, ldap_abandon_ext \- Abandon an LDAP operation in progress
@@ -10,24 +11,34 @@
 .nf
 .B #include <ldap.h>
 .sp
-.BI "int ldap_abandon(LDAP *" ld ", int " msgid ");"
-.sp
 .BI "int ldap_abandon_ext(LDAP *" ld ", int " msgid ","
 .RS
 .BI "LDAPControl *" sctrls "[], LDAPControl *" cctrls "[]);"
 .RE
+.sp
+.BI "int ldap_abandon(LDAP *" ld ", int " msgid ");"
 .fi
 .SH DESCRIPTION
-The
+The function                                                        
 .B ldap_abandon()
+has been deprecated in current versions of OpenLDAP, and should not be used
+in new software.  The prototype for this function is only avaliable if the 
+macro LDAP_DEPRECATED is defined before ldap.h is included.               
+Software that uses this function should be rewritten to use
+.BR ldap_abandon_ext(3)                                    
+instead.  
+.LP
+The
+.B ldap_abandon_ext()
 routine is used to abandon or cancel an LDAP
 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.
+.BR ldap_search_ext (3),
+.BR ldap_modify_ext (3),
+etc.  \fIsctrls\fP and \fIcctrls\fP are server and client controls 
+respectively, or NULL, if the corresponding control is not needed.
 .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,
 it sends an LDAP abandon operation to the the LDAP server.
@@ -36,31 +47,25 @@
 will not be returned from a future call to
 .BR ldap_result (3).
 .LP
-.B ldap_abandon_ext()
-is equivalent to
 .B ldap_abandon()
-except that it allows server and client controls to be passed
-in
-.I sctrls
-and
-.IR cctrls ,
-respectively.
+is equivalent to
+.B ldap_abandon_ext()
+except that it does not allow server and client controls to be passed.
 .SH ERRORS
-.B ldap_abandon()
-returns 0 if everything goes ok, -1 otherwise,
-setting \fIld_errno\fP with an appropriate LDAP error code.
-.LP
 .B ldap_abandon_ext()
-directly returns an LDAP error code indicating success or failure of the
+returns an LDAP error code indicating success or failure of the
 operation.
 .LP
+.B ldap_abandon()
+returns 0 if everything goes ok, -1 otherwise,
+.LP
 See
-.BR ldap_error (3)
+.BR ldap_err2string (3)
 for details.
 .SH SEE ALSO
 .BR ldap (3),
 .BR ldap_result (3),
-.BR ldap_error (3)
+.BR ldap_err2string (3)
 .SH ACKNOWLEDGEMENTS
 .B OpenLDAP
 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).