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
  12 #include <ldap.h>
  13 .LP
  14 .ft B
  15 int ldap_abandon_ext(
  16 .RS
  17 .ft B
  18 LDAP *\fIld\fB,
  19 Bint \fImsgid\fB,
  20 LDAPControl **\fIsctrls\fB,
  21 LDAPControl **\fIcctrls\fB );
  22 .RE
  23 .fi
  24 .SH DESCRIPTION
  25 The
  26 .B ldap_abandon_ext()
  27 routine is used to send a LDAP Abandon request for an
  28 operation in progress.  The \fImsgid\fP passed should be the
  29 message id of an outstanding LDAP operation, as returned by
  30 .BR ldap_search_ext (3),
  31 .BR ldap_modify_ext (3),
  32 etc.
  33 .LP
  34 .BR ldap_abandon_ext ()
  35 checks to see if the result of the operation has already come in.  If it
  36 has, it deletes it from the queue of pending messages.  If not,
  37 it sends an LDAP abandon request to the LDAP server.
  38 .LP
  39 The caller can expect that the result of an abandoned operation
  40 will not be returned from a future call to
  41 .BR ldap_result (3).
  42 .LP
  43 .B ldap_abandon_ext()
  44 allows server and client controls to be passed in via the
  45 .I sctrls
  46 and
  47 .I cctrls
  48 parameters, respectively.
  49 .SH ERRORS
  50 .B ldap_abandon_ext()
  51 returns an LDAP error code indicating success or failure in sending
  52 the Abandon request.
  53 .LP
  54 See
  55 .BR ldap_error (3)
  56 for details.
  57 .SH DEPRECATED INTERFACES
  58 The
  59 .B ldap_abandon()
  60 routine is deprecated in favor of the
  61 .B ldap_abandon_ext()
  62 routine.
  63 .LP
  64 .so Deprecated
  65
  66 .SH SEE ALSO
  67 .BR ldap (3),
  68 .BR ldap_result (3),
  69 .BR ldap_error (3)
  70 .SH ACKNOWLEDGEMENTS
  71 .so ../Project
  72