IFolderFilterSite
COM公式ドキュメント
クライアントが Shell フォルダーの列挙をどのようにフィルターするかを指定できるよう、ホストによって公開されます。
解説(Remarks)
このインターフェイスの最も一般的な用途は、アプリケーションが SHBrowseForFolder を呼び出す場合です。この関数を呼び出すと、アプリケーションはフォルダーブラウザーオブジェクトのクライアントになります。そのオブジェクトは、コールバック関数 BrowseCallbackProc にメッセージを送信することでクライアントと通信します。BFFM_IUNKNOWN メッセージには、フォルダーブラウザーの IUnknown インターフェイスへのポインターが含まれます。フォルダーの列挙をフィルターするには、次の手順を実行します。
- IUnknown ポインターを使用してフォルダーブラウザーの QueryInterface メソッドを呼び出し、IFolderFilterSite インターフェイスへのポインターを要求します。
- IFolderFilterSite::SetFilter を呼び出し、自身の IFolderFilter(IUnknown または IFilterFolder?)インターフェイスへのポインターをフォルダーブラウザーに渡します。
- その後、フォルダーブラウザーは IFolderFilterSite インターフェイスの 2 つのメソッドを照会し、列挙をどのようにフィルターするかを決定します。
メソッド 1
vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。
クライアントがホストに自身の IUnknown インターフェイスポインターを渡せるよう、ホストによって公開されます。
| punk | IUnknown* | in | クライアントの IUnknown インターフェイスへのポインター。フィルター処理を終了し、IFolderFilter インターフェイスの呼び出しを停止するようホストに通知するには、このパラメーターを NULL に設定します。 |
戻り値
型: HRESULT
このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。
解説(Remarks)
ホストの IFolderFilterSite インターフェイスへのポインターを取得した後、このメソッドを呼び出して、自身の IUnknown インターフェイスへのポインターをホストに渡します。ホストはこのポインターを使用して、自身の QueryInterface メソッドを呼び出し、IFolderFilter インターフェイスへのポインターを要求します。この呼び出しが失敗した場合、IFolderFilterSite::SetFilter は E_NOINTERFACEAVAILABLE を返します。呼び出しが成功した場合、ホストは IFolderFilter インターフェイスの 2 つのメソッドを呼び出して、フォルダーの内容をどのように列挙するかを決定します。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
HSP用 COM定義
#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。
#define global IID_IFolderFilterSite "{C0A651F5-B48B-11D2-B5ED-006097C686F6}"
#usecom global IFolderFilterSite IID_IFolderFilterSite "{}"
#comfunc global IFolderFilterSite_SetFilter 3 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。