ISharedPropertyGroup
COMIDispatch (デュアル)comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。公式ドキュメント
共有プロパティグループ内の共有プロパティを作成し、アクセスするために使用します。
メソッド 4
vtbl = vtable インデックス(0始まり)。IDispatch 実装のため HSP ではメソッド名でも呼べます(上記)。低レベルの index 呼び出し用に vtbl も掲載。0〜2 は IUnknown。
指定したインデックスで新しい共有プロパティを作成します。
| Index | INT | in | 新しいプロパティを参照するための、SharedPropertyGroup オブジェクト内の数値インデックスです。このインデックスは後で get_PropertyByPosition メソッドで共有プロパティを取得する際に使用できます。 |
| fExists | VARIANT_BOOL* | out | Boolean 値への参照です。このメソッドから戻る際に fExists が VARIANT_TRUE に設定されている場合、Index で指定された共有プロパティはこの呼び出しの前から存在していたことを示します。VARIANT_FALSE に設定されている場合は、この呼び出しによってプロパティが作成されたことを示します。 |
| ppProp | ISharedProperty** | out | Index パラメーターに渡された数値インデックスで識別される共有プロパティオブジェクトへの参照です。エラーが発生した場合は NULL になります。 |
戻り値
このメソッドは、標準の戻り値 E_INVALIDARG、E_OUTOFMEMORY、E_UNEXPECTED、E_FAIL、および S_OK を返すことができます。
解説(Remarks)
共有プロパティを作成すると、その値は既定値に設定されます。既定値は、値が 0 の VT_I4 VARIANT です。
CreatePropertyByPosition メソッドで SharedProperty オブジェクトを作成した場合、そのプロパティには get_PropertyByPosition メソッドを使用してのみアクセスできます。同じプロパティに文字列名を割り当てて、get_Property メソッドでアクセスすることはできません。位置によるプロパティへのアクセスは、オーバーヘッドが少ないため、文字列名を使用したアクセスよりも高速です。
同じ共有プロパティグループには、位置で識別される SharedProperty オブジェクトと、名前で識別されるオブジェクトの両方を含めることができます。
指定したインデックスを持つ既存の共有プロパティへの参照を取得します。
| Index | INT | in | 取得する共有プロパティの作成時に使用された数値インデックスです。 |
| ppProperty | ISharedProperty** | out | Index パラメーターで指定された共有プロパティへの参照です。プロパティが存在しない場合は NULL になります。 |
戻り値
このメソッドは、標準の戻り値 E_INVALIDARG、E_OUTOFMEMORY、および E_FAIL に加えて、次の値を返すことができます。
| 戻り値 | 説明 |
|---|---|
| 共有プロパティが存在し、その参照が ppProperty パラメーターで返されます。 | |
| Index パラメーターで指定されたインデックスを持つ共有プロパティが存在しません。 |
指定した名前で新しい共有プロパティを作成します。
| Name | LPWSTR | in | 作成するプロパティの名前です。この名前は後で get_Property メソッドを使用してこのプロパティへの参照を取得する際に使用できます。 |
| fExists | VARIANT_BOOL* | out | Boolean 値への参照です。Name パラメーターで指定された共有プロパティがこの呼び出しの前から存在していた場合、このメソッドから戻る際に VARIANT_TRUE に設定されます。この呼び出しによってプロパティが作成された場合は VARIANT_FALSE に設定されます。 |
| ppProp | ISharedProperty** | out | Name パラメーターで指定された名前を持つ SharedProperty オブジェクトへの参照です。エラーが発生した場合は NULL になります。 |
戻り値
このメソッドは、標準の戻り値 E_INVALIDARG、E_OUTOFMEMORY、E_UNEXPECTED、E_FAIL、および S_OK を返すことができます。
解説(Remarks)
共有プロパティを作成すると、その値は既定値に設定されます。既定値は、値が 0 の VT_I4 VARIANT です。
CreateProperty メソッドで共有プロパティを作成した場合、そのプロパティには get_Property メソッドを使用してのみアクセスできます。同じプロパティに数値インデックスを割り当てて、get_PropertyByPosition メソッドでアクセスすることはできません。
同じ共有プロパティグループには、名前で識別される SharedProperty オブジェクトと、位置で識別されるオブジェクトの両方を含めることができます。
指定した名前を持つ既存の共有プロパティへの参照を取得します。
| Name | LPWSTR | in | 取得する共有プロパティの作成時に使用された名前です。 |
| ppProperty | ISharedProperty** | out | Name パラメーターで指定された共有プロパティへの参照です。プロパティが存在しない場合は NULL になります。 |
戻り値
このメソッドは、標準の戻り値 E_INVALIDARG、E_OUTOFMEMORY、および E_FAIL に加えて、次の値を返すことができます。
| 戻り値 | 説明 |
|---|---|
| 共有プロパティが存在し、その参照が ppProperty パラメーターで返されます。 | |
| Name パラメーターで指定された名前を持つ共有プロパティが存在しません。 |
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
HSP用 COM定義
#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。
#define global IID_ISharedPropertyGroup "{2A005C07-A5DE-11CF-9E66-00AA00A3F464}" #usecom global ISharedPropertyGroup IID_ISharedPropertyGroup "{2A005C0B-A5DE-11CF-9E66-00AA00A3F464}" #comfunc global ISharedPropertyGroup_CreatePropertyByPosition 7 int,var,sptr #comfunc global ISharedPropertyGroup_get_PropertyByPosition 8 int,sptr #comfunc global ISharedPropertyGroup_CreateProperty 9 wstr,var,sptr #comfunc global ISharedPropertyGroup_get_Property 10 wstr,sptr ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※#usecom 末尾は CoCreateInstance 用のクラスID(コクラスCLSID, SDKから自動取得)。 ; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。 ; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。 ; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。#define global IID_ISharedPropertyGroup "{2A005C07-A5DE-11CF-9E66-00AA00A3F464}" #usecom global ISharedPropertyGroup IID_ISharedPropertyGroup "{2A005C0B-A5DE-11CF-9E66-00AA00A3F464}" #comfunc global ISharedPropertyGroup_CreatePropertyByPosition 7 int,sptr,sptr #comfunc global ISharedPropertyGroup_get_PropertyByPosition 8 int,sptr #comfunc global ISharedPropertyGroup_CreateProperty 9 wstr,sptr,sptr #comfunc global ISharedPropertyGroup_get_Property 10 wstr,sptr ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※#usecom 末尾は CoCreateInstance 用のクラスID(コクラスCLSID, SDKから自動取得)。 ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。 ; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。 ; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。