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

   1 .TH LDAP_ABANDON 3  "1 December 1994" "U-M LDAP LDVERSION"
   2 .SH NAME
   3 ldap_abandon \- Abandon an LDAP operation in progress
   4 .SH SYNOPSIS
   5 .nf
   6 .ft B
   7 #include <lber.h>
   8 #include <ldap.h>
   9 .LP
  10 .ft B
  11 int ldap_abandon(ld, msgid)
  12 .ft
  13 LDAP *ld;
  14 int msgid;
  15 .SH DESCRIPTION
  16 The
  17 .B ldap_abandon()
  18 routine is used to abandon or cancel an LDAP
  19 operation in progress.  The \fImsgid\fP passed should be the
  20 message id of an outstanding LDAP operation, as returned by
  21 .BR ldap_search (3),
  22 .BR ldap_modify (3),
  23 etc.
  24 .LP
  25 .BR ldap_abandon ()
  26 checks to see if the result of the operation has already come in.  If it
  27 has, it deletes it from the queue of pending messages.  If not,
  28 it sends an LDAP abandon operation to the the LDAP server.
  29 .LP
  30 The caller can expect that the result of an abandoned operation
  31 will not be returned from a future call to
  32 .BR ldap_result (3).
  33 .SH ERRORS
  34 .B ldap_abandon()
  35 returns 0 if everything goes ok, -1 otherwise,
  36 setting \fIld_errno\fP appropriately. See
  37 .BR ldap_error (3)
  38 for details.
  39 .SH SEE ALSO
  40 .BR ldap(3),
  41 .BR ldap_result(3),
  42 .B ldap_error(3)