ldap_abandon

Abandons an asynchronous LDAP operation already in progress. This function has been deprecated; LDAP v3 clients should use ldap_abandon_ext.

LDAP Version: v2 or higher
Library:*ldapsdk.*
NDS Version:7.xx or higher
Platform:NLM, Windows (NT, 95, 98, 2000, XP, Vista 32-bit and 64-bit ), Linux (32-bit and 64-bit), Solaris, AIX, and HP-UX

Syntax

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

Parameters

ld

(IN) Points to the handle for the LDAP session.

msgid

(IN) Specifies the message ID of the asynchronous LDAP operation to abandon.

Return Values

0

Success

-1

Failure

Remarks

The msgid parameter must specify a message ID returned by an outstanding asynchronous LDAP operation, such as ldap_search or ldap_modify.

The ldap_abandon function checks to see if the results of the operation has already come in.

  • If not, it sends an LDAP abandon operation to the LDAP server.

  • If the results have already come in, the LDAP operation cannot be abandoned.

If the ldap_abandon function returns -1, use the ldap_get_option function with the option parameter set to LDAP_OPT_RESULT_CODE to retrieve the error code from the LDAP session handle.

See Also

ldap_abandon_ext