IFolderFilter

サーバーアプリケーションによる Shell フォルダーの列挙を、クライアントがどのようにフィルターするかを指定するためにクライアントが公開するインターフェイスです。

このインターフェイスは、フォルダー選択ダイアログボックスに表示されるツリービューの内容をフィルターするために、SHBrowseForFolder とともに使用されることが最も多いです。IFolderFilter を SHBrowseForFolder とともに使用するには、BIF_NEWDIALOGSTYLE フラグを設定する必要があります。

アプリケーションが SHBrowseForFolder を呼び出すと、フォルダーブラウザーオブジェクトのクライアントになります。フォルダーブラウザーオブジェクトは、コールバック関数 BrowseCallbackProc にメッセージを送信することで通信します。そのコールバック関数が処理する BFFM_IUNKNOWN メッセージには、フォルダーブラウザーの IUnknown インターフェイスへのポインターが含まれています。フォルダーの内容の表示をフィルターするには、次の手順を実行します。

1. フォルダーブラウザーの QueryInterface メソッドを使用して、IFolderFilterSite インターフェイスへのポインターを要求します。
2. IFolderFilterSite::SetFilter を呼び出し、IFolderFilter インターフェイスへのポインターを渡します。
3. その後、フォルダーブラウザーは IFolderFilter::GetEnumFlags と IFolderFilter::ShouldShow に問い合わせて、列挙をどのようにフィルターするかを決定します。

個々の項目をフィルターで通過させるか、ブロックするかを指定します。

型: HRESULT

項目を表示すべき場合は S_OK、表示すべきでない場合は S_FALSE、エラーが発生した場合は標準的なエラーコードを返します。エラーが発生した場合、その項目は表示されません。

ホストは、psf または pidlFolder が参照するフォルダー内の各項目に対してこのメソッドを呼び出します。

実装では、psf と pidlItem の情報を、より扱いやすい IShellItem に変換することをお勧めします。次の例はこれを示しています。

STDMETHODIMP ShouldShow(IShellFolder *psf, 
                        PCIDLIST_ABSOLUTE pidlFolder, 
                        PCUITEMID_CHILD pidlItem)
{
    IShellItem *psi;

    HRESULT hr = SHCreateItemWithParent(NULL, psf, pidlItem, IID_PPV_ARGS(&psi));
    if (SUCCEEDED(hr))
    {
        // Determine here whether the item should be shown. This determination
        // is application-dependent.

        psi->Release();
    }

    return hr;
}

Shell フォルダー内のどのクラスのオブジェクトを列挙するかをクライアントが指定できるようにします。SHBrowseForFolder とともに使用する場合、ダイアログボックスのツリービューに表示すべき項目のクラスと、表示すべきでないクラスを指定します。

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。