ldap_search_abandon_page function

The ldap_search_abandon_page function terminates a paged-results search.

Syntax

ULONG ldap_search_abandon_page(
  _In_ PLDAP       ExternalHandle,
  _In_ PLDAPSearch SearchBlock
);

Parameters

ExternalHandle [in]

The session handle.

SearchBlock [in]

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

See also

Functions

Return Values