IPropertyPageSite

COM

IIDb196b28c-bab4-101a-b69c-00aa00341d07継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

プロパティページサイトオブジェクトの主要な機能を提供します。

解説(Remarks)

プロパティフレーム内で作成される各プロパティページに対して、フレームはプロパティページサイトを作成し、プロパティページに情報を提供するとともに、変更が発生した際にページからの通知を受け取ります。この後者の通知は、IPropertyPage::IsPageDirty の呼び出しを開始するために使用され、その戻り値によってフレームの [適用] ボタンの有効/無効が切り替えられます。

OLE の実装

システムは、OleCreatePropertyFrame 関数または OleCreatePropertyFrameIndirect 関数を通じて、IPropertyPageSite インターフェイスの実装を提供します。これらの関数によって提供されるフレームの実装は、OnStatusChange メソッドと GetLocaleID メソッドのみを実装しています。GetPageContainer メソッドと TranslateAccelerator メソッドは E_NOTIMPL を返します。

メソッド 4

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

vtbl 3 HRESULT OnStatusChange(DWORD dwFlags)

このサイトが管理するプロパティページの状態が変化したこと、すなわちページ内の 1 つ以上のプロパティ値が変更されたことをフレームに通知します。プロパティページは、ダイアログボックス内で変更が発生するたびにこのメソッドを呼び出す必要があります。

dwFlags

DWORD

発生した変更を示します。このパラメーターには、次のいずれかの値を指定できます。

値	意味
PROPPAGESTATUS_DIRTY 0x1	ページ内の値が変更されたため、[適用] ボタンの状態を更新する必要があります。
PROPPAGESTATUS_VALIDATE 0x2	今が変更を適用するのに適したタイミングです。

戻り値

このメソッドは、標準の戻り値である E_INVALIDARG および S_OK を返すことができます。

vtbl 4 HRESULT GetLocaleID(DWORD* pLocaleID)

プロパティページがロケール固有の設定を調整するために使用できるロケール識別子 (LCID) を取得します。

pLocaleID

DWORD*

out

ロケール識別子を受け取る変数へのポインター。言語識別子の定数と文字列を参照してください。

戻り値

このメソッドは、次の値を返すことができます。

戻り値	説明
S_OK	メソッドは正常に完了しました。
E_POINTER	pLocaleID のアドレスが無効です。たとえば、NULL である可能性があります。

vtbl 5 HRESULT GetPageContainer(IUnknown** ppUnk)

すべてのページを含むプロパティフレームダイアログボックス全体を表すオブジェクトへのポインターを取得します。このメソッドを呼び出すことで、あるページから別のページへ移動できる可能性があります。

ppUnk

IUnknown**

out

コンテナーオブジェクトへのインターフェイスポインターを受け取る IUnknown ポインター変数へのポインター。エラーが発生した場合、実装は *ppUnk を NULL に設定する必要があります。

戻り値

このメソッドは E_NOTIMPL を返します。

vtbl 6 HRESULT TranslateAccelerator(MSG* pMsg)

処理のためにキーストロークをプロパティフレームに渡します。

pMsg

MSG*

処理対象の MSG 構造体へのポインター。

戻り値

このメソッドは、次の値を返すことができます。

戻り値	説明
S_OK	メソッドは正常に完了しました。
S_FALSE	ページサイトはメッセージを処理しませんでした。
E_NOTIMPL	ページサイトはキーボード処理をサポートしていません。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IPropertyPageSite "{B196B28C-BAB4-101A-B69C-00AA00341D07}"
#usecom global IPropertyPageSite IID_IPropertyPageSite "{}"
#comfunc global IPropertyPageSite_OnStatusChange        3 int
#comfunc global IPropertyPageSite_GetLocaleID           4 var
#comfunc global IPropertyPageSite_GetPageContainer      5 sptr
#comfunc global IPropertyPageSite_TranslateAccelerator  6 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IPropertyPageSite "{B196B28C-BAB4-101A-B69C-00AA00341D07}"
#usecom global IPropertyPageSite IID_IPropertyPageSite "{}"
#comfunc global IPropertyPageSite_OnStatusChange        3 int
#comfunc global IPropertyPageSite_GetLocaleID           4 sptr
#comfunc global IPropertyPageSite_GetPageContainer      5 sptr
#comfunc global IPropertyPageSite_TranslateAccelerator  6 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。