Win32 API 日本語リファレンス
ホームUI.Shell › ICommDlgBrowser

ICommDlgBrowser

COM
IID000214f1-0000-0000-c000-000000000046継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

コモンファイルダイアログボックスが Shell ブラウザーをホストする際に使用するために公開されるインターフェイスです。

解説(Remarks)

Note Windows XP 以前では、このインターフェイスは Shlobj.h で定義されていました。
このインターフェイスは、コモンファイルダイアログボックスによってのみ実装されます。

コモンダイアログボックス内にホストされている間に特別な動作を提供する必要がある場合は、ICommDlgBrowser を使用します。

メソッド 3

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 3 HRESULT OnDefaultCommand(IShellView* ppshv)

ユーザーがビュー内でダブルクリックしたとき、または ENTER キーを押したときに呼び出されます。

ppshvIShellView*inビューの IShellView インターフェイスへのポインター。

戻り値

型: HRESULT

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

解説(Remarks)

ブラウザーは、アクションを処理した場合は S_OK を返し、ビューに既定のアクションを実行させる場合は S_FALSE を返す必要があります。

呼び出し側アプリケーションへの注意

このメソッドを使用すると、既定のコマンドをビューではなくコモンダイアログボックスで処理できるようになります。
vtbl 4 HRESULT OnStateChange(IShellView* ppshv, DWORD uChange)

uChange パラメーターで識別される状態が IShellView インターフェイス内で変化した後に呼び出されます。

ppshvIShellView*inビューの IShellView インターフェイスへのポインター。
uChangeDWORDin

選択状態の変化。このパラメーターには、次のいずれかの値を指定できます。

CDBOSC_SETFOCUS

ビューにフォーカスが設定されました。

CDBOSC_KILLFOCUS

ビューがフォーカスを失いました。

CDBOSC_SELCHANGE

選択が変更されました。

CDBOSC_RENAME

項目の名前が変更されました。

CDBOSC_STATECHANGE

項目がチェックまたはチェック解除されました。

戻り値

型: HRESULT

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

解説(Remarks)

このメソッドは、コモンファイルダイアログボックスがビューの状態を追跡し、必要に応じてユーザーインターフェイスを変更できるようにするために使用されます。

呼び出し側アプリケーションへの注意

ビュー内の項目が選択されたとき、またはビューがフォーカスを失ったときに、ビューはこのメソッドを呼び出して、ビューの状態または選択状態が変化していることをコモンダイアログに通知する必要があります。
vtbl 5 HRESULT IncludeObject(IShellView* ppshv, ITEMIDLIST* pidl)

コモンダイアログボックスがビューに表示するオブジェクトをフィルターできるようにします。

ppshvIShellView*inビューの IShellView インターフェイスへのポインター。
pidlITEMIDLIST*inフォルダーからの相対位置でオブジェクトを識別する PIDL。

戻り値

型: HRESULT

ブラウザーは、オブジェクトをビューに含める場合は S_OK を返し、非表示にする場合は S_FALSE を返す必要があります。

解説(Remarks)

このメソッドは、ファイルダイアログボックスにホストされているときに IEnumIDList の実装によって呼び出されます。列挙子はこのメソッドを呼び出して、コモンダイアログボックスが表示すべきでないオブジェクトを除外できるようにします。通常、ファイルダイアログボックスは項目の表示テキストを取得し、拡張子でフィルターします。

呼び出し側アプリケーションへの注意

Shell フォルダーの IDLIST 列挙子でオブジェクトを返す前に、このメソッドを呼び出してください。

ライブラリや検索など、多数の項目を持つデータソースを扱う場合、このメソッドへのコールバックはパフォーマンスの低下を招きます。この状況を回避するには、GetViewFlags を実装して CDB2GVF_NOINCLUDEITEM を返します。そうすることで、ビューが ICommDlgBrowser::IncludeObject の呼び出しをスキップできるようになり、パフォーマンスが向上します。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"

出力引数:
#define global IID_ICommDlgBrowser "{000214F1-0000-0000-C000-000000000046}"
#usecom global ICommDlgBrowser IID_ICommDlgBrowser "{}"
#comfunc global ICommDlgBrowser_OnDefaultCommand  3 sptr
#comfunc global ICommDlgBrowser_OnStateChange     4 sptr,int
#comfunc global ICommDlgBrowser_IncludeObject     5 sptr,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。