ホーム › System.ComponentServices › IContextState

IContextState

COM

📘 Microsoft Learn (日本語) · English

IID3c05e54b-a42a-11d2-afc4-00c04f8ee1c4継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

コンテキスト状態フラグを操作することで、オブジェクトの非アクティブ化とトランザクションの投票を制御します。

メソッド 4

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

vtbl 3 HRESULT SetDeactivateOnReturn(VARIANT_BOOL bDeactivate)

done フラグを設定します。このフラグは、メソッドの戻り時にオブジェクトを非アクティブ化するかどうかを制御します。

bDeactivate

VARIANT_BOOL

done フラグ。

戻り値

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

戻りコード	説明
S_OK	メソッドは正常に完了しました。
CONTEXT_E_NOJIT	Just-in-Time Activation はこのコンテキストでは使用できません。

解説(Remarks)

true に設定すると、done フラグはメソッド呼び出しの戻り時にオブジェクトを非アクティブ化します。false に設定すると、オブジェクトはメソッド呼び出しの戻り後もアクティブなままになります。 done フラグの既定値は false です。

vtbl 4 HRESULT GetDeactivateOnReturn(VARIANT_BOOL* pbDeactivate)

done フラグの値を取得します。

pbDeactivate

VARIANT_BOOL*

inout

done フラグ。

戻り値

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

戻りコード	説明
S_OK	メソッドは正常に完了しました。
CONTEXT_E_NOJIT	Just-in-Time Activation はこのコンテキストでは使用できません。

解説(Remarks)

トランザクションのルートオブジェクトに対して pbDeactivate が FALSE の場合、クライアントがオブジェクトへの参照を解放するか、done フラグが TRUE に設定されるまで、オブジェクトは非アクティブ化されず、トランザクションも終了しません。

vtbl 5 HRESULT SetMyTransactionVote(TransactionVote txVote)

consistent フラグを設定します。

txVote

TransactionVote

consistent フラグ。値の一覧については、TransactionVote 列挙型を参照してください。consistent フラグが true の場合はこのパラメーターを TxCommit に設定し、false の場合は TxAbort に設定します。

戻り値

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

戻りコード	説明
S_OK	メソッドは正常に完了しました。
CONTEXT_E_NOJIT	Just-in-Time Activation はこのコンテキストでは使用できません。

解説(Remarks)

COM+ はオブジェクトを非アクティブ化するときにのみこのフラグを検査し、フラグはメソッド呼び出し内で複数回設定できます。

consistent フラグの既定値は true です。

vtbl 6 HRESULT GetMyTransactionVote(TransactionVote* ptxVote)

consistent フラグの値を取得します。

ptxVote

TransactionVote*

inout

consistent フラグ。値の一覧については、TransactionVote 列挙型を参照してください。consistent フラグが true の場合、このパラメーターは TxCommit に設定され、false の場合は TxAbort に設定されます。

戻り値

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

戻りコード	説明
S_OK	メソッドは正常に完了しました。
CONTEXT_E_NOTRANSACTION	オブジェクトはトランザクション内で実行されていません。

解説(Remarks)

メソッドが失敗した場合は、HRESULT の値に基づいて、トランザクションが存在しないことを判断できる場合があります。メソッドが成功した場合は、consistent フラグに基づく値を返します。この値から、オブジェクトをコミットできるか、または中止する必要があるかを判断できます。オブジェクトの状態に関係なく、オブジェクトはトランザクションに参加している必要があります。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IContextState "{3C05E54B-A42A-11D2-AFC4-00C04F8EE1C4}"
#usecom global IContextState IID_IContextState "{}"
#comfunc global IContextState_SetDeactivateOnReturn  3 int
#comfunc global IContextState_GetDeactivateOnReturn  4 var
#comfunc global IContextState_SetMyTransactionVote   5 int
#comfunc global IContextState_GetMyTransactionVote   6 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。#define global IID_IContextState "{3C05E54B-A42A-11D2-AFC4-00C04F8EE1C4}"
#usecom global IContextState IID_IContextState "{}"
#comfunc global IContextState_SetDeactivateOnReturn  3 int
#comfunc global IContextState_GetDeactivateOnReturn  4 sptr
#comfunc global IContextState_SetMyTransactionVote   5 int
#comfunc global IContextState_GetMyTransactionVote   6 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。