ICommDlgBrowser::IncludeObject

Quick Info

Windows NT
Yes
Win95
Yes
Win32s
No
Import Library
-
Header File
shlobj.h
Unicode
No
Platform Notes
None

[Now Supported on Windows NT]

IncludeObject is used to allow the common dialog filter objects that the view presents.

HRESULT IncludeObject(

LPCITEMIDLIST pidl	//Pointer to an identifier list.
);

Parameters
pidl

Pointer to a identifier list (IDLIST) that is relative to the folder.

Return Values
The browser should return S_OK to include the object in the view, S_FALSE to hide it.

Remarks
IncludeObject is called by the IEnumIDList implementation when hosted in the file dialogs. The enumerator should call this function to let the common dialog filter out objects it does not want to display. Typically, the file dialogs will get the display text of the item, and filter by the extension.

Notes to Callers
Call before returning an object in the shell folder's IDList enumerator.