ldap_search_abandon_page function (winldap.h)

The ldap_search_abandon_page function terminates a paged-results search.

Syntax

WINLDAPAPI ULONG LDAPAPI ldap_search_abandon_page(
  [in] PLDAP       ExternalHandle,
  [in] PLDAPSearch SearchBlock
);

Parameters

[in] ExternalHandle

The session handle.

[in] SearchBlock

A handle to the search block for the current search.

Return value

If the function succeeds, the return value is LDAP_SUCCESS.

If the function fails, it returns an error code. See Return Values for more information.

Remarks

Call ldap_search_abandon_page after a search has completed (when the server returns LDAP_NO_RESULTS_RETURNED) to perform necessary cleanup. You can also use this function to abandon a search at any time after the search block has been allocated.

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

Return Values