ldap_search_abandon_page (Compact 2013)

  • Article

3/26/2014

This function terminates a paged-results search.

Syntax

ULONG ldap_search_abandon_page(
  LDAP* ExternalHandle,
  LDAPSearch* SearchBlock
);

Parameters

  • ExternalHandle
    [in] Session handle.
  • SearchBlock
    [in] Handle to the search block for the current search.

Return Value

If this function succeeds, the return value is LDAP_SUCCESS.

If this function fails, it returns an error code. See the LDAP_RETCODE enumeration for a list of possible return values.

Remarks

Call this function 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

Header

winldap.h

Library

wldap32.lib

See Also

Reference

LDAP Search Functions
LDAP_RETCODE