ldap_abandon function
A client calls ldap_abandon to cancel an in-process asynchronous LDAP call.
Syntax
ULONG ldap_abandon( _In_ LDAP *ld, _Out_ ULONG msgid );
Parameters
- ld [in]
-
The session handle.
- msgid [out]
-
The message ID of the call to be canceled. Asynchronous functions 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
|
Minimum supported client | Windows 2000 Professional [desktop apps only] |
|---|---|
|
Minimum supported server | Windows 2000 Server [desktop apps only] |
|
Header |
|
|
Library |
|
|
DLL |
|
See also
Send comments about this topic to Microsoft
Build date: 10/26/2012
