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-2015 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, such as returned by
  30 .BR ldap_search_ext (3).
  31 .LP
  32 .BR ldap_abandon_ext ()
  33 checks to see if the result of the operation has already come in.  If it
  34 has, it deletes it from the queue of pending messages.  If not,
  35 it sends an LDAP abandon request to the LDAP server.
  36 .LP
  37 The caller can expect that the result of an abandoned operation
  38 will not be returned from a future call to
  39 .BR ldap_result (3).
  40 .LP
  41 .B ldap_abandon_ext()
  42 allows server and client controls to be passed in via the
  43 .I sctrls
  44 and
  45 .I cctrls
  46 parameters, respectively.
  47 .LP
  48 .B ldap_abandon_ext()
  49 returns a code indicating success or, in the case of failure, the
  50 nature of the failure.  See
  51 .BR ldap_error (3)
  52 for details.
  53 .SH DEPRECATED INTERFACES
  54 The
  55 .B ldap_abandon()
  56 routine is deprecated in favor of the
  57 .B ldap_abandon_ext()
  58 routine.
  59 .LP
  60 .so Deprecated
  61
  62 .SH SEE ALSO
  63 .BR ldap (3),
  64 .BR ldap_error (3),
  65 .BR ldap_result (3),
  66 .BR ldap_search_ext (3)
  67 .SH ACKNOWLEDGEMENTS
  68 .so ../Project
  69