external/bsd/openldap/man/ldap_abandon.3

   1 .TH LDAP_ABANDON 3 "2008/07/16" "OpenLDAP 2.4.11"
   2 .\" $OpenLDAP: pkg/ldap/doc/man/man3/ldap_abandon.3,v 1.17.2.4 2008/02/11 23:26:39 kurt Exp $
   3 .\" Copyright 1998-2008 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 Deprecated interfaces generally remain in the library.  The macro
  61 LDAP_DEPRECATED can be defined to a non-zero value
  62 (e.g., -DLDAP_DEPRECATED=1) when compiling program designed to use
  63 deprecated interfaces.  It is recommended that developers writing new
  64 programs, or updating old programs, avoid use of deprecated interfaces.
  65 Over time, it is expected that documentation (and, eventually, support) for
  66 deprecated interfaces to be eliminated.
  67
  68 .SH SEE ALSO
  69 .BR ldap (3),
  70 .BR ldap_error (3),
  71 .BR ldap_result (3),
  72 .BR ldap_search_ext (3)
  73 .SH ACKNOWLEDGEMENTS
  74 .\" Shared Project Acknowledgement Text
  75 .B "OpenLDAP Software"
  76 is developed and maintained by The OpenLDAP Project <http://www.openldap.org/>.
  77 .B "OpenLDAP Software"
  78 is derived from University of Michigan LDAP 3.3 Release.
  79