Home | History | Annotate | Line # | Download | only in man 
      1 .lf 1 stdin
      2 .TH LDAP_ABANDON 3 "2025/05/22" "OpenLDAP 2.6.10"
      3 .\" $OpenLDAP$
      4 .\" Copyright 1998-2024 The OpenLDAP Foundation All Rights Reserved.
      5 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
      6 .SH NAME
      7 ldap_abandon_ext \- Abandon an LDAP operation in progress
      8 .SH LIBRARY
      9 OpenLDAP LDAP (libldap, \-lldap)
     10 .SH SYNOPSIS
     11 .nf
     12 .B
     13 #include <ldap.h>
     14 .LP
     15 .ft B
     16 int ldap_abandon_ext(
     17 .RS
     18 .ft B
     19 LDAP *\fIld\fB,
     20 Bint \fImsgid\fB,
     21 LDAPControl **\fIsctrls\fB,
     22 LDAPControl **\fIcctrls\fB );
     23 .RE
     24 .fi
     25 .SH DESCRIPTION
     26 The
     27 .B ldap_abandon_ext()
     28 routine is used to send a LDAP Abandon request for an
     29 operation in progress.  The \fImsgid\fP passed should be the
     30 message id of an outstanding LDAP operation, such as returned by
     31 .BR ldap_search_ext (3).
     32 .LP
     33 .BR ldap_abandon_ext ()
     34 checks to see if the result of the operation has already come in.  If it
     35 has, it deletes it from the queue of pending messages.  If not,
     36 it sends an LDAP abandon request to the LDAP server.
     37 .LP
     38 The caller can expect that the result of an abandoned operation
     39 will not be returned from a future call to
     40 .BR ldap_result (3).
     41 .LP
     42 .B ldap_abandon_ext()
     43 allows server and client controls to be passed in via the
     44 .I sctrls
     45 and
     46 .I cctrls
     47 parameters, respectively.
     48 .LP
     49 .B ldap_abandon_ext()
     50 returns a code indicating success or, in the case of failure, the
     51 nature of the failure.  See
     52 .BR ldap_error (3)
     53 for details.
     54 .SH DEPRECATED INTERFACES
     55 The
     56 .B ldap_abandon()
     57 routine is deprecated in favor of the
     58 .B ldap_abandon_ext()
     59 routine. 
     60 .LP
     61 .lf 1 ./Deprecated
     62 Deprecated interfaces generally remain in the library.  The macro
     63 LDAP_DEPRECATED can be defined to a non-zero value
     64 (e.g., -DLDAP_DEPRECATED=1) when compiling program designed to use
     65 deprecated interfaces.  It is recommended that developers writing new
     66 programs, or updating old programs, avoid use of deprecated interfaces.
     67 Over time, it is expected that documentation (and, eventually, support) for
     68 deprecated interfaces to be eliminated.
     69 .lf 61 stdin
     70 
     71 .SH SEE ALSO
     72 .BR ldap (3),
     73 .BR ldap_error (3),
     74 .BR ldap_result (3),
     75 .BR ldap_search_ext (3)
     76 .SH ACKNOWLEDGEMENTS
     77 .lf 1 ./../Project
     78 .\" Shared Project Acknowledgement Text
     79 .B "OpenLDAP Software"
     80 is developed and maintained by The OpenLDAP Project <http://www.openldap.org/>.
     81 .B "OpenLDAP Software"
     82 is derived from the University of Michigan LDAP 3.3 Release.  
     83 .lf 69 stdin
     84 
     85