ldap_abandon(3) — Linux manual page

NAME | LIBRARY | SYNOPSIS | DESCRIPTION | DEPRECATED INTERFACES | SEE ALSO | ACKNOWLEDGEMENTS | COLOPHON

LDAP_ABANDON(3)         Library Functions Manual         LDAP_ABANDON(3)

NAME         top

       ldap_abandon_ext - Abandon an LDAP operation in progress

LIBRARY         top

       OpenLDAP LDAP (libldap, -lldap)

SYNOPSIS         top

       #include <ldap.h>

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

DESCRIPTION         top

       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 parameters, 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         top

       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 interfaces.  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         top

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

ACKNOWLEDGEMENTS         top

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

COLOPHON         top

       This page is part of the OpenLDAP (an open source implementation
       of the Lightweight Directory Access Protocol) project.
       Information about the project can be found at 
       ⟨http://www.openldap.org/⟩.  If you have a bug report for this
       manual page, see ⟨http://www.openldap.org/its/⟩.  This page was
       obtained from the project's upstream Git repository
       ⟨https://git.openldap.org/openldap/openldap.git⟩ on 2021-04-01.
       (At that time, the date of the most recent commit that was found
       in the repository was 2021-04-01.)  If you discover any rendering
       problems in this HTML version of the page, or you believe there
       is a better or more up-to-date source for the page, or you have
       corrections or improvements to the information in this COLOPHON
       (which is not part of the original manual page), send a mail to
       man-pages@man7.org

OpenLDAP LDVERSION             RELEASEDATE               LDAP_ABANDON(3)