Directory Services

ldap_abandon

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

ULONG ldap_abandon(
  LDAP* ld,
  ULONG msgid
);

Parameters

ld
[in] The session handle.
msgid
[out] The message ID of the call to be cancelled. Asynchronous functions return this message ID when they initiate an operation.

Return Values

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

Client: Included in Windows XP and Windows 2000 Professional.
Server: Included in Windows Server 2003 and Windows 2000 Server.
Redistributable: Requires Active Directory Client Extension on Windows NT 4.0 SP6a and Windows 95/98/Me.
Header: Declared in Winldap.h.
Library: Use Wldap32.lib.

See Also

Functions, ldap_result