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

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

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(), etc.

This API 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 OS/400 authority is required. All authority checking is done by the LDAP server.

Parameters

ld

(Input) Specifies 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 and ldap_modify, etc.

serverctrls

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

clientctrls

(Input) Specifies a list of LDAP client controls. This parameter may be set to null. See LDAP Controls 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 set from this function.
    CPF3CF2 E  Error(s) occurred during running of ldap_abandon_ext API.

Related Information

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