IShellFolderSearchable::InvalidateSearch method

Makes this pointer to an item identifier list (PIDL) an invalid portion of the Shell folder.

Syntax

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

Parameters

pidlSearch [in]

Type: LPCITEMIDLIST

A pointer to the ITEMIDLIST structure for the search folder.

pdwFlags [in]

Type: DWORD*

No flags are currently defined; set to NULL.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

When a search folder is invalidated, it can perform cleanup of any resources it has used. The IShellFolderSearchable::InvalidateSearch method may cause an asynchronous search to be canceled and will result in the eventual release of the IShellFolderSearchableCallback interface object.

Requirements

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