ldap_abandon_ext(3) Mac OS X Manual Page

Mac Dev Center Mac OS X Reference Library General Mac OS X Man Pages

This manual page is for Mac OS X version 10.6.3

If you are running a different version of Mac OS X, view the documentation locally:

In Terminal, using the man(1) command

Reading manual pages

Manual pages are intended as a quick reference for people who already understand a technology.

For more information about the manual page format, see the manual page for manpages(5).
For more information about this technology, look for other documentation in the Apple Reference Library.
For general information about writing shell scripts, read Shell Scripting Primer.


LDAP_ABANDON(3)                                                                              LDAP_ABANDON(3)



NAME
       ldap_abandon_ext - Abandon an LDAP operation in progress

LIBRARY
       OpenLDAP LDAP (libldap, -lldap)

SYNOPSIS
       #include <ldap.h>

       int ldap_abandon_ext(
              LDAP *ld,
              Bint msgid,
              LDAPControl **sctrls,
              LDAPControl **cctrls );

DESCRIPTION
       The  ldap_abandon_ext()  routine is used to send a LDAP Abandon request for an operation in progress.
       The msgid passed should be the message id of an outstanding  LDAP  operation,  such  as  returned  by
       ldap_search_ext(3).

       ldap_abandon_ext()  checks  to see if the result of the operation has already come in.  If it has, it
       deletes it from the queue of pending messages.  If not, it sends an LDAP abandon request to the  LDAP
       server.

       The  caller  can  expect that the result of an abandoned operation will not be returned from a future
       call to ldap_result(3).

       ldap_abandon_ext() allows server and client controls to be passed in via the sctrls and cctrls param-eters, parameters,
       eters, respectively.

       ldap_abandon_ext()  returns  a  code indicating success or, in the case of failure, the nature of the
       failure.  See ldap_error(3) for details.

DEPRECATED INTERFACES
       The ldap_abandon() routine is deprecated in favor of the ldap_abandon_ext() routine.

       Deprecated interfaces generally remain in the library.  The macro LDAP_DEPRECATED can be defined to a
       non-zero  value  (e.g., -DLDAP_DEPRECATED=1) when compiling program designed to use deprecated inter-faces. interfaces.
       faces.  It is recommended that developers writing new programs, or updating old programs,  avoid  use
       of  deprecated  interfaces.   Over time, it is expected that documentation (and, eventually, support)
       for deprecated interfaces to be eliminated.


SEE ALSO
       ldap(3), ldap_error(3), ldap_result(3), ldap_search_ext(3)

ACKNOWLEDGEMENTS
       OpenLDAP Software is developed and maintained by  The  OpenLDAP  Project  <http://www.openldap.org/>.
       OpenLDAP Software is derived from University of Michigan LDAP 3.3 Release.




OpenLDAP 2.4.11                                  2008/07/16                                  LDAP_ABANDON(3)

Reporting Problems

The way to report a problem with this manual page depends on the type of problem:

Content errors: Report errors in the content of this documentation with the feedback links below.
Bug reports: Report bugs in the functionality of the described tool or API through Bug Reporter.
Formatting problems: Report formatting mistakes in the online version of these pages with the feedback links below.

Did this document help you?