PROPPAGEINFO 構造体 (ocidl.h)

  • [アーティクル]

プロパティ ページをプロパティ フレームに記述するために使用されるパラメーターが含まれます。 プロパティ ページは、 IPropertyPage::GetPageInfo メソッドの呼び出し元が指定した構造体を格納します。

構文

typedef struct tagPROPPAGEINFO {
  ULONG    cb;
  LPOLESTR pszTitle;
  SIZE     size;
  LPOLESTR pszDocString;
  LPOLESTR pszHelpFile;
  DWORD    dwHelpContext;
} PROPPAGEINFO, *LPPROPPAGEINFO;

メンバー

cb

この構造体のサイズ (バイト単位)。

pszTitle

このページのタブに表示される文字列を含む OLESTR へのポインター。 文字列は CoTaskMemAlloc で割り当てる必要があります。 IPropertyPage::GetPageInfo の呼び出し元は、CoTaskMemFree を使用してメモリを解放する役割を担います。

size

ページのダイアログ ボックスの必要なサイズ (ピクセル単位)。

pszDocString

ページを記述するテキスト文字列へのポインター。プロパティ シート ダイアログ ボックスに表示できます (現在のフレーム実装では、このフィールドは使用されません)。 テキストは CoTaskMemAlloc で割り当てる必要があります。 IPropertyPage::GetPageInfo の呼び出し元は、CoTaskMemFree を使用してメモリを解放する役割を担います。

pszHelpFile

IPropertyPage::Help を実装する代わりに使用されるこのプロパティ ページを記述するヘルプ ファイルの単純な名前を含む OLESTR へのポインター。 ユーザーが [ヘルプ] を押すと、通常は Help メソッドが呼び出されます。 このメソッドが失敗した場合、フレームはこのヘルプ ファイルを使用してヘルプ システムを開き (CLSID の下にあるプロパティ ページのレジストリ エントリの HelpDir キーの値がプレフィックスとして付けられます)、 dwHelpContext フィールドによって記述されたコンテキストを表示するようにヘルプ システムに指示します。 パスは CoTaskMemAlloc で割り当てる必要があります。 IPropertyPage::GetPageInfo の呼び出し元は、CoTaskMemFree を使用してメモリを解放する役割を担います。

dwHelpContext

このページを説明する pszHelpFile 内のヘルプ トピックのコンテキスト識別子。

注釈

この構造体で指定された pszTitle、 pszDocString、 および pszHelpFile メンバーには、 IPropertyPageSite::GetLocaleID によって取得されたロケールに依存するテキストが含まれている必要があります。

要件

要件 値
サポートされている最小のクライアント Windows 2000 Professional [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows 2000 Server [デスクトップ アプリのみ]
Header ocidl.h

こちらもご覧ください

IPropertyPage::GetPageInfo

IPropertyPageSite::GetLocaleID

OLESTR