ICommDlgBrowser3::IncludeObject Method

Allows the common dialog box to filter objects that the view displays.

Syntax

HRESULT IncludeObject(      
    IShellView *ppshv,
    LPCITEMIDLIST pidl
);

Parameters

  • ppshv
    A pointer to the view's IShellView interface.
  • pidl
    A pointer to an item identifier list (PIDL) that is relative to the folder.

Return Value

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

Remarks

This method is called by the IEnumIDList implementation when hosted in the file dialog boxes. The enumerator calls this method to let the common dialog box filter out objects that should not be displayed. Typically, the file dialog boxes will get the display text of the item, and filter by the extension.

Note to Calling Applications

Call before returning an object in the Shell folder's IDLIST enumerator.

See Also

ICommDlgBrowser