IPropertyStoreFactory
COM公式ドキュメント
IPropertyStore オブジェクトを取得するためのメソッドを公開します。
解説(Remarks)
このインターフェイスは通常、IShellFolder::BindToObject または IShellItem::BindToHandler を通じて取得します。IShellItem2::GetPropertyStore を介したプロパティストアの作成に伴う追加のオーバーヘッドを避けたいデータソースの実装者にとって有用です。ただし、Shell フォルダー拡張を通じてデータソースを実装する場合を除き、プロパティストアを取得する推奨メソッドは IShellItem2::GetPropertyStore です。
メソッド 2
vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。
指定されたフラグに対応する IPropertyStore オブジェクトを取得します。
| flags | GETPROPERTYSTOREFLAGS | in | 返されるストアを変更する GETPROPERTYSTOREFLAGS 値。 |
| pUnkFactory | IUnknown* | in | 省略可能。ICreateObject を実装するオブジェクトの IUnknown へのポインター。pUnkFactory が指定されている場合、このメソッドは(実装されていれば)CoCreateInstance ではなく ICreateObject を使用してハンドラーのインスタンスを作成できます。pUnkFactory を指定する理由は通常、別のプロセスでハンドラーを作成するためです。ただし、ほとんどのユーザーにとっては、このパラメーターに NULL を渡せば十分です。 |
| riid | GUID* | in | 作成するオブジェクトの IID への参照。 |
| ppv | void** | out | このメソッドが返るときに、IPropertyStore インターフェイスポインターのアドレスが格納されます。 |
戻り値
型: HRESULT
このメソッドが成功すると S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。
解説(Remarks)
Objbase.h で定義されている IID_PPV_ARGS マクロを使用して、riid パラメーターと ppv パラメーターをまとめることをお勧めします。このマクロは、ppv の値が指すインターフェイスに基づいて正しい IID を提供するため、コーディングエラーの可能性を排除できます。
プロパティキーのセットを指定して IPropertyStore オブジェクトを取得します。これは、IPropertyStoreFactory::GetPropertyStore を呼び出す場合と比較して、IPropertyStore オブジェクトを取得するための代替手段(場合によってはより高速な手段)を提供します。
| rgKeys | PROPERTYKEY* | in | PROPERTYKEY 構造体の配列へのポインター。 |
| cKeys | DWORD | in | rgKeys が指す配列内の PROPERTYKEY 構造体の数。 |
| flags | GETPROPERTYSTOREFLAGS | in | 返されるストアを変更する GETPROPERTYSTOREFLAGS 値。 |
| riid | GUID* | in | 作成するオブジェクトの IID への参照。 |
| ppv | void** | out | このメソッドが返るときに、IPropertyStore インターフェイスポインターのアドレスが格納されます。 |
戻り値
型: HRESULT
このメソッドが成功すると S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。
解説(Remarks)
Objbase.h で定義されている IID_PPV_ARGS マクロを使用して、riid パラメーターと ppv パラメーターをまとめることをお勧めします。このマクロは、ppv の値が指すインターフェイスに基づいて正しい IID を提供するため、コーディングエラーの可能性を排除できます。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
HSP用 COM定義
#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。
#define global IID_IPropertyStoreFactory "{BC110B6D-57E8-4148-A9C6-91015AB2F3A5}" #usecom global IPropertyStoreFactory IID_IPropertyStoreFactory "{}" #comfunc global IPropertyStoreFactory_GetPropertyStore 3 int,sptr,var,sptr #comfunc global IPropertyStoreFactory_GetPropertyStoreForKeys 4 var,int,int,var,sptr ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。 ; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IPropertyStoreFactory "{BC110B6D-57E8-4148-A9C6-91015AB2F3A5}" #usecom global IPropertyStoreFactory IID_IPropertyStoreFactory "{}" #comfunc global IPropertyStoreFactory_GetPropertyStore 3 int,sptr,sptr,sptr #comfunc global IPropertyStoreFactory_GetPropertyStoreForKeys 4 sptr,int,int,sptr,sptr ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。 ; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。