IShellPropSheetExt
COM公式ドキュメント
プロパティシートハンドラーが、ファイルオブジェクトに対して表示されるプロパティシートにページを追加または置換できるようにするメソッドを公開します。
メソッド 2
vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。
Shell がファイルオブジェクトに対して表示するプロパティシートに、1 つ以上のページを追加します。Shell は、そのファイルタイプに登録されている各プロパティシートハンドラーに対してこのメソッドを呼び出します。
| pfnAddPage | LPFNSVADDPROPSHEETPAGE | in | プロパティシートにページを追加するためにプロパティシートハンドラーが呼び出す関数へのポインターです。この関数は、CreatePropertySheetPage 関数が返すプロパティシートハンドルと、このメソッドに渡された lParam パラメーターを受け取ります。 |
| lParam | LPARAM | in | pfnAddPage が指す関数に渡す、ハンドラー固有のデータです。 |
戻り値
型: HRESULT
成功した場合、最初に表示すべきページを指定する 1 から始まるインデックスを返します。詳細は「解説」を参照してください。
解説(Remarks)
プロパティシートハンドラーがプロパティシートに追加する必要がある各ページについて、ハンドラーは PROPSHEETPAGE 構造体に値を設定し、CreatePropertySheetPage 関数を呼び出し、その後 pfnAddPage が指す関数を呼び出します。
LPFNADDPROPSHEETPAGE 関数ポインター型は、Prsht.h において次のように定義されています。これは PROPSHEETPAGE 構造体へのハンドルと、lParam を通じて渡される関数定義のデータを受け取ります。
typedef BOOL (* LPFNADDPROPSHEETPAGE)(HPROPSHEETPAGE, LPARAM);
実装を通じて、既定のページの代わりに特定のプロパティシートページを最初に表示するよう要求できます。そのためには、追加したページを基準として、目的のページの 1 から始まるインデックスを返します。たとえば、A、B、C という 3 つのプロパティシートページを追加し、B を選択されたページにしたい場合、戻り値は 2 になります。なお、この戻り値はあくまで要求にすぎない点に注意してください。プロパティシートは依然として既定のページを表示する場合があります。
コントロールパネルオブジェクトのプロパティシート内のページを置換します。
| uPageID | DWORD | in | 使用されません。 Microsoft Windows XP およびそれ以前: 置換するページの EXPPS 型識別子です。コントロールパネル用のこのパラメーターの値は、Cplext.h ヘッダーファイルに記載されています。 |
| pfnReplaceWith | LPFNSVADDPROPSHEETPAGE | in | プロパティシートのページを置換するためにプロパティシートハンドラーが呼び出す関数へのポインターです。この関数は、CreatePropertySheetPage 関数が返すプロパティシートハンドルと、ReplacePage メソッドに渡された lParam パラメーターを受け取ります。 |
| lParam | LPARAM | in | pfnReplacePage パラメーターで指定した関数に渡すパラメーターです。 |
戻り値
型: HRESULT
このメソッドが成功した場合、S_OK を返します。それ以外の場合は、HRESULT エラーコードを返します。
解説(Remarks)
ページを置換するには、プロパティシートハンドラーは PROPSHEETPAGE 構造体に値を設定し、CreatePropertySheetPage を呼び出し、その後 pfnReplacePage で指定した関数を呼び出します。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
HSP用 COM定義
#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。
#define global IID_IShellPropSheetExt "{000214E9-0000-0000-C000-000000000046}"
#usecom global IShellPropSheetExt IID_IShellPropSheetExt "{}"
#comfunc global IShellPropSheetExt_AddPages 3 sptr,sptr
#comfunc global IShellPropSheetExt_ReplacePage 4 int,sptr,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。