IFolderFilterSite Interface

IID_IFolderFilterSite

{C0A651F5-B48B-11d2-B5ED-006097C686F6}

This interface is exported by a host to allow clients to specify how to filter a Shell folder enumeration.

Remarks

The most common use of this interface is when your application calls SHBrowseForFolder. When you call this function, you become a client of the folder browser object. That object communicates with you by sending messages to a callback function, BrowseCallbackProc. The BFFM_IUNKNOWN message contains a pointer to the folder browser's IUnknown interface. To filter folder enumeration:

1. Use the IUnknown pointer to call the folder browser's QueryInterface method, and request a pointer to the IFolderFilterSite interface.

2. Call IFolderFilterSite::SetFilter, and pass the folder browser a pointer to your IFolderFilter (IUnknown or IFilterFolder?) interface.

3. The folder browser will then query the two methods of the IFolderFilterSite interface to determine how to filter the enumeration.

Methods in VTable order

IUnknown Methods

Description

QueryInterface

Returns pointers to supported interfaces.

AddRef

Increments reference count.

Release

Decrements reference count.

IFolderFilterSite Method

Description

SetFilter

Exposed by a host to allow clients to pass the host their IUnknown interface pointers.

SetFilter

FUNCTION IFolderFilterSite_SetFilter ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL punk AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[3] USING IFolderFilterSite_SetFilter (pthis, punk) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION