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

   1 .TH LDAP_ABANDON 3 "22 September 1998" "OpenLDAP LDVERSION"
   2 .\" $OpenLDAP$
   3 .\" Copyright 1998-2000 The OpenLDAP Foundation All Rights Reserved.
   4 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
   5 .SH NAME
   6 ldap_abandon \- Abandon an LDAP operation in progress
   7 .SH SYNOPSIS
   8 .nf
   9 .ft B
  10 #include <ldap.h>
  11 .LP
  12 .ft B
  13 int ldap_abandon(ld, msgid)
  14 .ft
  15 LDAP *ld;
  16 int msgid;
  17 .SH DESCRIPTION
  18 The
  19 .B ldap_abandon()
  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 (3),
  24 .BR ldap_modify (3),
  25 etc.
  26 .LP
  27 .BR ldap_abandon ()
  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 .SH ERRORS
  36 .B ldap_abandon()
  37 returns 0 if everything goes ok, -1 otherwise,
  38 setting \fIld_errno\fP appropriately. See
  39 .BR ldap_error (3)
  40 for details.
  41 .SH SEE ALSO
  42 .BR ldap(3),
  43 .BR ldap_result(3),
  44 .B ldap_error(3)
  45 .SH ACKNOWLEDGEMENTS
  46 .B      OpenLDAP
  47 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
  48 .B      OpenLDAP
  49 is derived from University of Michigan LDAP 3.3 Release.