Share via

ldap_abandon (Compact 2013)

  • Article

3/26/2014

This function is called by a client to cancel an in-progress asynchronous LDAP call.

Syntax

ULONG ldap_abandon(
  LDAP* ld,
  ULONG msgid
);

Parameters

  • ld
    [in] Session handle.
  • msgid
    [out] Message identifier of the call to be canceled. Asynchronous functions return this message identifier when they initiate an operation.

Return Value

If the function succeeds (the cancellation is successful), the return value is 0.

If this function fails, the return value is -1.

Remarks

This function first checks to see whether the operation has been completed. If it has, the message identifier is deleted; otherwise, the call goes to the server to cancel the operation.

Note

A successful call to this function destroys the message identifier. Therefore, you cannot call the ldap_result function to obtain results with that message identifier, 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.

In a multithreading environment, calls to this function are thread-safe.

Requirements

Header

winldap.h

Library

wldap32.lib

See Also

Reference

LDAP Session Functions
ldap_result