IFileOpenDialog
COM公式ドキュメント
IFileDialog インターフェイスを拡張し、開くダイアログに固有のメソッドを追加します。
解説(Remarks)
実装するタイミング
IFileOpenDialog は、共通のファイルを開くダイアログ (CLSID_FileOpenDialog) によって実装されます。このインターフェイスは、継承元である IFileDialog インターフェイスのメソッドも提供します。
メソッド 2
vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。
複数選択を許可するダイアログにおいて、ユーザーが選択した項目を取得します。
| ppenum | IShellItemArray** | out | ダイアログで選択された項目にアクセスするための IShellItemArray へのポインターのアドレス。 |
戻り値
型: HRESULT
このメソッドが成功した場合、S_OK を返します。それ以外の場合は、HRESULT エラーコードを返します。
解説(Remarks)
このメソッドは、選択が単一の項目であっても複数の項目であっても使用できます。
IFileOpenDialog::GetResults は、ダイアログが閉じられた後、または IFileDialogEvents::OnFileOk イベントの処理中に呼び出すことができます。それ以外のタイミングでこのメソッドを呼び出すと失敗します。
IFileOpenDialog::GetResults で結果を利用できるようにするには、Show が成功コードを返している必要があります。
ダイアログで現在選択されている項目を取得します。これらの項目は、ビューで選択された項目、またはファイル名編集ボックスで選択されたテキストの場合があります。
| ppsai | IShellItemArray** | out | 選択された項目にアクセスするための IShellItemArray へのポインターのアドレス。 |
戻り値
型: HRESULT
このメソッドが成功した場合、S_OK を返します。それ以外の場合は、HRESULT エラーコードを返します。
解説(Remarks)
このメソッドは、単一項目の選択にも複数項目の選択にも使用できます。ユーザーがファイル名フィールドに新しいテキストを入力している場合、これは時間のかかる操作になることがあります。アプリケーションがこのメソッドを呼び出すと、アプリケーションは filename フィールドのテキストを解析します。たとえば、これがネットワーク共有である場合、操作に時間がかかる可能性があります。ただし、ユーザーは操作を中止できる必要があるため、この操作が UI をブロックすることはありません (中止した場合、IFileOpenDialog::GetSelectedItems は失敗コードを返します)。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
HSP用 COM定義
#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。
#define global IID_IFileOpenDialog "{D57C7288-D4AD-4768-BE02-9D969532D960}"
#usecom global IFileOpenDialog IID_IFileOpenDialog "{DC1C5A9C-E88A-4DDE-A5A1-60F82A20AEF7}"
#comfunc global IFileOpenDialog_GetResults 27 sptr
#comfunc global IFileOpenDialog_GetSelectedItems 28 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※#usecom 末尾は CoCreateInstance 用のクラスID(コクラスCLSID, SDKから自動取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。