Win32 API 日本語リファレンス
ホーム › System.Ole › ISpecifyPropertyPages

ISpecifyPropertyPages

COM
📘 Microsoft Learn (日本語) · English
IIDb196b28b-bab4-101a-b69c-00aa00341d07継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

オブジェクトがプロパティページをサポートしていることを示します。

解説(Remarks)

プロパティページオブジェクトは、プロパティシート内の特定のページを管理します。プロパティページは少なくとも IPropertyPage を実装し、特定のプロパティの選択をサポートする場合は、オプションで IPropertyPage2 を実装できます。

オブジェクトは、ISpecifyPropertyPages を実装することでプロパティページのサポートを指定します。このインターフェイスを通じて、呼び出し側はオブジェクトがサポートする特定のプロパティページを識別する CLSID の一覧を取得できます。オブジェクトがプロパティページの CLSID を指定する場合、そのオブジェクトはプロパティページからのプロパティ変更を受け取れる必要があります。

メソッド 1

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

vtbl 3 HRESULT GetPages(CAUUID* pPages)

このオブジェクトのプロパティシートに表示できるプロパティページの一覧を取得します。

pPagesCAUUID*out呼び出し側が割り当てた CAUUID 構造体へのポインター。この関数は、戻る前にこの構造体を初期化して値を設定します。構造体内の pElems メンバーは、この関数が CoTaskMemAlloc を使用して割り当てるため、呼び出し側は CoTaskMemFree を使用して解放する必要があります。

戻り値

このメソッドは、標準の戻り値である E_OUTOFMEMORY および E_UNEXPECTED に加えて、次の値を返すことがあります。

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

解説(Remarks)

CAUUID 構造体は呼び出し側によって割り当てられますが、呼び出し側による初期化は行われません。GetPages メソッドは、構造体内の cElements メンバーに値を設定します。また、このメソッドは CoTaskMemAlloc を使用して pElems メンバーが指す配列のメモリを割り当てます。その後、新たに割り当てた配列に値を設定します。このメソッドが正常に戻ると、構造体には UUID の要素数付き配列が格納され、各 UUID がプロパティページの CLSID を指定します。

呼び出し側への注意

呼び出し側は、CAUUID の pElems メンバーが指すメモリが不要になったら、CoTaskMemFree を使用して解放する必要があります。

実装者への注意

プロパティページを持たないオブジェクトは ISpecifyPropertyPages インターフェイスを公開すべきではないため、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_ISpecifyPropertyPages "{B196B28B-BAB4-101A-B69C-00AA00341D07}"
#usecom global ISpecifyPropertyPages IID_ISpecifyPropertyPages "{}"
#comfunc global ISpecifyPropertyPages_GetPages  3 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。