ホーム › System.ComponentServices › ISharedPropertyGroupManager
ISharedPropertyGroupManager
COMIDispatch (デュアル)✅ IDispatch を実装(デュアルインターフェース)。HSP では
comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。公式ドキュメント
共有プロパティグループを作成し、既存の共有プロパティグループへのアクセスを取得するために使用します。
メソッド 3
vtbl = vtable インデックス(0始まり)。IDispatch 実装のため HSP ではメソッド名でも呼べます(上記)。低レベルの index 呼び出し用に vtbl も掲載。0〜2 は IUnknown。
vtbl 7 HRESULT CreatePropertyGroup(LPWSTR Name, INT* dwIsoMode, INT* dwRelMode, VARIANT_BOOL* fExists, ISharedPropertyGroup** ppGroup)
新しい共有プロパティグループを作成します。
| Name | LPWSTR | in | 作成する共有プロパティグループの名前。 |
| dwIsoMode | INT* | inout | 新しい共有プロパティグループ内のプロパティに対する分離モード。下記の解説にある定数の表を参照してください。このメソッドから戻る際に fExists パラメーターの値が VARIANT_TRUE に設定されている場合、入力値は無視され、このパラメーターで返される値はプロパティグループが作成されたときに割り当てられた分離モードになります。 |
| dwRelMode | INT* | inout | 新しい共有プロパティグループ内のプロパティに対する解放モード。下記の解説にある定数の表を参照してください。このメソッドから戻る際に fExists パラメーターの値が VARIANT_TRUE に設定されている場合、入力値は無視され、このパラメーターで返される値はプロパティグループが作成されたときに割り当てられた解放モードになります。 |
| fExists | VARIANT_BOOL* | out | name パラメーターで指定された共有プロパティグループがこの呼び出しの前から存在していた場合、このメソッドからの戻り時に VARIANT_TRUE になります。プロパティグループがこの呼び出しによって作成された場合は VARIANT_FALSE になります。 |
| ppGroup | ISharedPropertyGroup** | out | Name パラメーターで識別される共有プロパティグループである ISharedPropertyGroup への参照。エラーが発生した場合は NULL。 |
戻り値
このメソッドは、標準の戻り値 E_OUTOFMEMORY、E_UNEXPECTED、E_FAIL に加えて、次の値を返すことがあります。
| 戻り値コード | 説明 |
|---|---|
| Name パラメーターで指定された共有プロパティグループへの参照が ppGroup パラメーターで返されます。 | |
| 呼び出し元が COM+ 上で実行されていません。共有プロパティマネージャーを使用するには、呼び出し元が COM+ 上で実行されている必要があります。 | |
| 少なくとも 1 つのパラメーターが無効であるか、同じオブジェクトが同じプロパティグループを複数回作成しようとしています。 |
解説(Remarks)
次の定数は、共有プロパティグループの有効な分離モードを指定するために使用します。
| 定数 | 値 | 説明 |
|---|---|---|
| LockSetGet | 0 | 既定値。呼び出し中にプロパティをロックすることで、共有プロパティに対するすべての取得操作および設定操作がアトミックであることを保証します。これにより、2 つのクライアントが同時に同じプロパティを読み書きすることはできなくなりますが、他のクライアントが同じグループ内の別のプロパティに同時にアクセスすることは妨げられません。 |
| LockMethod | 1 | この値は、呼び出し元の現在のメソッドが実行されている間、共有プロパティグループ内のすべてのプロパティを呼び出し元による排他利用のためにロックします。これは、プロパティ間に相互依存関係がある場合や、クライアントがプロパティを読み取った直後、再びアクセスされる前にそのプロパティを更新しなければならない場合に適したモードです。 |
注 分離モードを LockMethod に設定すると、共有プロパティマネージャーは呼び出し元オブジェクトのオブジェクトコンテキストへのアクセスを必要とします。オブジェクトの構築中はオブジェクトコンテキストが利用できず、また基本クライアントはオブジェクトコンテキストを持たないため、この分離モードを使用してオブジェクトのコンストラクター内から、または COM+ 以外のオブジェクトから共有プロパティグループを作成することはできません。
| 定数 | 値 | 説明 |
|---|---|---|
| Standard | 0 | 既定値。すべてのクライアントがプロパティグループへの参照を解放すると、プロパティグループは自動的に破棄されます。 |
| Process | 1 | プロパティグループは、それが作成されたプロセスが終了するまで破棄されません。プロパティグループへの参照を保持するオブジェクトは、それでもなお自身の参照に対して Release を呼び出す必要があります。 |
注 オブジェクトは、共有プロパティグループの参照を別のオブジェクトに渡そうとしてはいけません。参照を取得したオブジェクトの外部に参照が渡されると、それはもはや有効な参照ではなくなります。
vtbl 8 HRESULT get_Group(LPWSTR Name, ISharedPropertyGroup** ppGroup)
既存の共有プロパティグループへの参照を取得します。
| Name | LPWSTR | in | 取得する共有プロパティグループの名前。 |
| ppGroup | ISharedPropertyGroup** | out | Name パラメーターで指定された共有プロパティグループへの参照。プロパティグループが存在しない場合は NULL。 |
戻り値
このメソッドは、標準の戻り値 E_OUTOFMEMORY、E_UNEXPECTED、E_FAIL に加えて、次の値を返すことがあります。
| 戻り値コード | 説明 |
|---|---|
| 共有プロパティグループが存在し、それへの参照が ppGroup パラメーターで返されます。 | |
| Name パラメーターで指定された名前を持つ共有プロパティグループが存在しません。 |
名前付きセキュリティ呼び出しコンテキストプロパティの列挙子を取得します。
| retval | IUnknown** | out | 返される IEnumVARIANT インターフェイスへの参照。 |
戻り値
このメソッドは、標準の戻り値 E_INVALIDARG、E_OUTOFMEMORY、E_UNEXPECTED、E_FAIL、S_OK を返すことがあります。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
HSP用 COM定義
#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。
出力引数:
#define global IID_ISharedPropertyGroupManager "{2A005C0D-A5DE-11CF-9E66-00AA00A3F464}" #usecom global ISharedPropertyGroupManager IID_ISharedPropertyGroupManager "{2A005C11-A5DE-11CF-9E66-00AA00A3F464}" #comfunc global ISharedPropertyGroupManager_CreatePropertyGroup 7 wstr,var,var,var,sptr #comfunc global ISharedPropertyGroupManager_get_Group 8 wstr,sptr #comfunc global ISharedPropertyGroupManager_get__NewEnum 9 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_ISharedPropertyGroupManager "{2A005C0D-A5DE-11CF-9E66-00AA00A3F464}" #usecom global ISharedPropertyGroupManager IID_ISharedPropertyGroupManager "{2A005C11-A5DE-11CF-9E66-00AA00A3F464}" #comfunc global ISharedPropertyGroupManager_CreatePropertyGroup 7 wstr,sptr,sptr,sptr,sptr #comfunc global ISharedPropertyGroupManager_get_Group 8 wstr,sptr #comfunc global ISharedPropertyGroupManager_get__NewEnum 9 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 不要)。