ldap_abandon()--Abandon an LDAP Operation in Progress

Syntax

 #include <ldap.h>
 
 int ldap_abandon(
        LDAP            *ld,
        int             msgid)

  Library Name/Service Program: QSYS/QGLDCLNT

  Default Public Authority: *USE

  Threadsafe: Yes

The ldap_abandon() function is used to abandon or cancel an LDAP operation in progress. The msgid passed should be the message ID of an outstanding LDAP operation, as returned by a call to an asynchronous LDAP operation such as ldap_search(), ldap_modify(), and so on.

The ldap_abandon() APIs check to see if the result of the operation has already been returned by the server. If it has, it deletes it from the queue of pending messages. If not, it sends an LDAP abandon operation to the 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().

Authorities and Locks

No IBM^® i authority is required.

Parameters

ld: (Input) The LDAP pointer returned by a previous call to ldap_init(), ldap_ssl_init(), or ldap_open().
msgid: (Input) The message ID of an outstanding LDAP operation, as returned by a call to an asynchronous LDAP operation such as ldap_search() or ldap_modify().

Return Value

LDAP_SUCCESS: if the request was successful.
-1: if the request was not successful.

Error Conditions

If ldap_abandon() is not successful, ld_errno will be set to indicate the error. See LDAP Client API Error Conditions for possible LDAP error codes values and ldap_get_errno() function to retrieve the error information.

Error Messages

The following message may be sent from this function.

Message ID	Error Message Text
CPF3CF2 E	Error(s) occurred during running of ldap_abandon API.

Related Information

ldap_abandon_ext() -- Abandon (abort) an asynchronous operation with controls.

API introduced: V4R3

[ Back to top | LDAP APIs | APIs by category ]