IShellPropSheetExt::AddPages メソッド (shobjidl_core.h)

シェルがファイル オブジェクトに対して表示するプロパティ シートに 1 つ以上のページを追加します。 シェルは、ファイルの種類に登録されているプロパティ シート ハンドラーごとにこのメソッドを呼び出します。

構文

HRESULT AddPages(
  [in] LPFNSVADDPROPSHEETPAGE pfnAddPage,
  [in] LPARAM                 lParam
);

パラメーター

[in] pfnAddPage

種類: LPFNADDPROPSHEETPAGE

プロパティ シート ハンドラーがプロパティ シートにページを追加するために呼び出す関数へのポインター。 関数は、 CreatePropertySheetPage 関数によって返されるプロパティ シート ハンドルと、このメソッドに渡される lParam パラメーターを受け取ります。

[in] lParam

型: LPARAM

pfnAddPage が指す関数に渡すハンドラー固有のデータ。

戻り値

型: HRESULT

成功した場合は、最初に表示するページを指定する 1 から始まるインデックスを返します。 詳細については、「解説」を参照してください。

注釈

プロパティ シート ハンドラーがプロパティ シートに追加する必要がある各ページについて、ハンドラーは PROPSHEETPAGE 構造体を埋め、 CreatePropertySheetPage 関数を呼び出し、 pfnAddPage が指す関数を呼び出します。

LPFNADDPROPSHEETPAGE 関数ポインター型は、次に示すように Prsht.h で定義されています。 これは、lParam を介して PROPSHEETPAGE 構造体と関数定義データへのハンドルを受け入れます。

typedef BOOL (* LPFNADDPROPSHEETPAGE)(HPROPSHEETPAGE, LPARAM);

実装を通じて、既定のページではなく、特定のプロパティ シート ページを最初に表示することを要求できます。 これを行うには、追加したページを基準にして、目的のページの 1 から始まるインデックスを返します。 たとえば、A、B、C の 3 つのプロパティ シート ページを追加し、B を選択したページにする場合、戻り値は 2 になります。 この戻り値は要求のみであることに注意してください。 プロパティ シートには、引き続き既定のページが表示される場合があります。

要件

要件	値
サポートされている最小のクライアント	Windows XP (デスクトップ アプリのみ)
サポートされている最小のサーバー	Windows 2000 Server [デスクトップ アプリのみ]
対象プラットフォーム	Windows
ヘッダー	shobjidl_core.h (Shobjidl.h を含む)
[DLL]	Shell32.dll (バージョン 4.0 以降)