ldap_abandon_ext()--Abandon (abort) an Asynchronous Operation with Controls

 #include <ldap.h>
 
 int ldap_abandon_ext(
        LDAP            *ld,
        int             msgid,
        LDAPControl     **serverctrls,
        LDAPControl     **clientctrls)

The ldap_abandon_ext() 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.

This API checks to see if the result of the operation has already been returned by the server. If it has, the result is removed 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.

serverctrls

(Input) A list of LDAP server controls. This parameter may be set to null. See Controls for LDAP APIs for more information about server controls.

clientctrls

(Input) A list of LDAP client controls. This parameter may be set to null. See Controls for LDAP APIs for more information about client controls.

Return Value

LDAP_SUCCESS

if the ldap_abandon() was successful.

Other LDAP error code

if the request was not successful.

Error Conditions

If ldap_abandon_ext() is not successful, LDAP error code will be returned. See LDAP Client API Error Conditions for possible LDAP error codes values.

Error Messages

The following message may be sent from this function.

Related Information

• ldap_abandon() -- Abandon (abort) an asynchronous operation.

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