Edit

ldap_abandon function (winldap.h)

  • Article

A client calls ldap_abandon to cancel an in-process asynchronous LDAP call.

Syntax

WINLDAPAPI ULONG LDAPAPI ldap_abandon(
  [in] LDAP  *ld,
  [in] ULONG msgid
);

Parameters

[in] ld

The session handle.

[in] msgid

The message ID of the call to be canceled. Asynchronous functions, such as ldap_search and ldap_modify, return this message ID when they initiate an operation.

Return value

If the function succeeds, that is, if the cancel operation is successful, the return value is zero.

If the function fails, the return value is –1.

Remarks

The ldap_abandon function first verifies that the operation has been completed. If it has, the message ID is deleted; otherwise, the call goes to the server to cancel the operation. Be aware that a successful call to ldap_abandon destroys the message ID. Therefore, you cannot call ldap_result to obtain results with that message ID, even if the server completed the operation.

There is no server response to ldap_abandon; thus, there is no guarantee that the call reached the server.

Multithreading: Calls to ldap_abandon are thread-safe.

Requirements

Requirement Value
Minimum supported client Windows Vista
Minimum supported server Windows Server 2008
Target Platform Windows
Header winldap.h
Library Wldap32.lib
DLL Wldap32.dll

See also

Functions

ldap_result