IShellFolderSearchable::CancelAsyncSearch method

Begins the process of canceling a pending asynchronous search.

Syntax

HRESULT CancelAsyncSearch(
  [in] LPCITEMIDLIST pidlSearch,
  [in] DWORD         *pdwFlags
);

Parameters

pidlSearch [in]

Type: LPCITEMIDLIST

A pointer to an ITEMIDLIST for the search.

pdwFlags [in]

Type: DWORD*

No flags are currently defined; set to NULL.

Return value

Type: HRESULT

Returns S_OK if canceling, or S_FALSE if search is not running.

Remarks

When the search is actually canceled, RunEnd will be called.

Requirements

Requirement Value
Minimum supported client
Windows 2000 Professional [desktop apps only]
Minimum supported server
Windows 2000 Server [desktop apps only]
DLL
Shell32.dll