ldap_search_abandon_page

The ldap_search_abandon_page function terminates a paged-results search.

ULONG ldap_search_abandon_page(
  PLDAP ExternalHandle,
  PLDAPSearch SearchBlock
);

Parameters

ExternalHandle

[in] The session handle.

SearchBlock

[in] A handle to the search block for the current search.

Return Values

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

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, Return Values