Win32 API 日本語リファレンス
ホーム › UI.Shell.PropertiesSystem › IPropertyStoreCache

IPropertyStoreCache

COM
📘 Microsoft Learn (日本語) · English
IID3017056d-9a91-4e90-937d-746c72abbf4f継承元IPropertyStore自前メソッド開始 vtbl8

公式ドキュメント

ハンドラーが各プロパティのさまざまな状態を管理できるようにするメソッドを公開します。

解説(Remarks)

このインターフェイスは、継承元である IPropertyStore インターフェイスのメソッドも提供します。

実装するタイミング

このインターフェイスの実装は CLSID_InMemoryPropertyStore によって提供されます。ユーザーが自分で実装する必要はありません。

CLSID_InMemoryPropertyStore は、各プロパティに関する追加情報(PSC_STATE)を格納できるように、IPropertyStore やその他のインターフェイスに加えて IPropertyStoreCache を実装しています。この情報はプロパティハンドラーの実装者にとって有用です。また、プロパティ値のキャッシュが必要なその他のシナリオでも役立ちます。

メソッド 4

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

vtbl 8 HRESULT GetState(PROPERTYKEY* key, PSC_STATE* pstate)

指定したプロパティキーの状態を取得します。

keyPROPERTYKEY*inPROPERTYKEY 構造体への参照です。
pstatePSC_STATE*outPSC_STATE 列挙値へのポインターです。

戻り値

型: HRESULT

このメソッドが成功すると S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 9 HRESULT GetValueAndState(PROPERTYKEY* key, PROPVARIANT* ppropvar, PSC_STATE* pstate)

プロパティキーの値と状態のデータを取得します。

keyPROPERTYKEY*inプロパティを識別する PROPERTYKEY 構造体への参照です。
ppropvarPROPVARIANT*outプロパティデータを格納する PROPVARIANT 構造体へのポインターです。
pstatePSC_STATE*outプロパティの現在の状態を示す PSC_STATE 列挙値へのポインターです。

戻り値

型: HRESULT

このメソッドが成功すると S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 10 HRESULT SetState(PROPERTYKEY* key, PSC_STATE state)
keyPROPERTYKEY*in状態を設定する対象のプロパティキー(PROPERTYKEY)へのポインタを渡す。
statePSC_STATEin設定するプロパティのキャッシュ状態(PSC_STATE)を指定する。
vtbl 11 HRESULT SetValueAndState(PROPERTYKEY* key, PROPVARIANT* ppropvar, PSC_STATE state)

プロパティキーの値と状態のデータを設定します。

keyPROPERTYKEY*inプロパティを識別する PROPERTYKEY 構造体への参照です。
ppropvarPROPVARIANT*inプロパティデータを格納する PROPVARIANT 構造体へのポインターです。
statePSC_STATEinプロパティの状態を示す PSC_STATE 列挙体の値です。

戻り値

型: HRESULT

このメソッドが成功すると S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IPropertyStoreCache "{3017056D-9A91-4E90-937D-746C72ABBF4F}"
#usecom global IPropertyStoreCache IID_IPropertyStoreCache "{}"
#comfunc global IPropertyStoreCache_GetState          8 var,var
#comfunc global IPropertyStoreCache_GetValueAndState  9 var,var,var
#comfunc global IPropertyStoreCache_SetState          10 var,int
#comfunc global IPropertyStoreCache_SetValueAndState  11 var,var,int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。