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-2005 The OpenLDAP Foundation All Rights Reserved.
   4 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
   5 .SH NAME
   6 ldap_abandon, 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 .sp
  13 .BI "int ldap_abandon(LDAP *" ld ", int " msgid ");"
  14 .sp
  15 .BI "int ldap_abandon_ext(LDAP *" ld ", int " msgid ","
  16 .RS
  17 .BI "LDAPControl *" sctrls "[], LDAPControl *" cctrls "[]);"
  18 .RE
  19 .fi
  20 .SH DESCRIPTION
  21 The
  22 .B ldap_abandon()
  23 routine is used to abandon or cancel an LDAP
  24 operation in progress.  The \fImsgid\fP passed should be the
  25 message id of an outstanding LDAP operation, as returned by
  26 .BR ldap_search (3),
  27 .BR ldap_modify (3),
  28 etc.
  29 .LP
  30 .BR ldap_abandon ()
  31 checks to see if the result of the operation has already come in.  If it
  32 has, it deletes it from the queue of pending messages.  If not,
  33 it sends an LDAP abandon operation to the the LDAP server.
  34 .LP
  35 The caller can expect that the result of an abandoned operation
  36 will not be returned from a future call to
  37 .BR ldap_result (3).
  38 .LP
  39 .B ldap_abandon_ext()
  40 is equivalent to
  41 .B ldap_abandon()
  42 except that it allows server and client controls to be passed
  43 in
  44 .I sctrls
  45 and
  46 .IR cctrls ,
  47 respectively.
  48 .SH ERRORS
  49 .B ldap_abandon()
  50 returns 0 if everything goes ok, -1 otherwise,
  51 setting \fIld_errno\fP with an appropriate LDAP error code.
  52 .LP
  53 .B ldap_abandon_ext()
  54 directly returns an LDAP error code indicating success or failure of the
  55 operation.
  56 .LP
  57 See
  58 .BR ldap_error (3)
  59 for details.
  60 .SH SEE ALSO
  61 .BR ldap (3),
  62 .BR ldap_result (3),
  63 .BR ldap_error (3)
  64 .SH ACKNOWLEDGEMENTS
  65 .B OpenLDAP
  66 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
  67 .B OpenLDAP
  68 is derived from University of Michigan LDAP 3.3 Release.