git.sur5r.net Git - openldap/blob - doc/man/man3/ldap_abandon.3

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