Win32 API 日本語リファレンス
ホームSystem.ComponentServices › ITransactionContextEx

ITransactionContextEx

COM
IID7999fc22-d3c6-11cf-acab-00a024a55aef継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

トランザクションを開始する汎用的なトランザクショナルオブジェクトの基本的なメソッドを提供します。このインターフェイスのメソッドを呼び出すことで、複数の COM+ オブジェクトの処理を単一のトランザクションにまとめ、そのトランザクションを明示的にコミットまたはアボートできます。

解説(Remarks)

トランザクションコンテキストオブジェクトを使用してトランザクションを制御すると、トランザクションを駆動するビジネスロジックの再利用性が制限されるため、使用は必要最小限にとどめるべきです。

ITransactionContext インターフェイスへの参照は、次の例のように適切な呼び出しでトランザクションコンテキストオブジェクトを作成することで取得します。

hr = CoCreateInstance(
       CLSID_TransactionContextEx, 
       NULL, 
       CLSCTX_INPROC,
       IID_ITransactionContextEx, 
       (void**)&m_pTransactionContext);

メソッド 3

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

vtbl 3 HRESULT CreateInstance(GUID* rclsid, GUID* riid, void** pObject)

トランザクションコンテキストオブジェクトによって開始されたトランザクションのスコープ内で実行できる COM オブジェクトを作成します。(ITransactionContextEx.CreateInstance)

rclsidGUID*inインスタンス化するオブジェクトの型の CLSID への参照。
riidGUID*in新しいオブジェクトとの通信に使用するインターフェイスのインターフェイス ID への参照。
pObjectvoid**outriid パラメーターで指定したインターフェイスを介して、rclsid パラメーターで指定した型の新しいオブジェクトへの参照。

戻り値

このメソッドは、標準の戻り値 E_INVALIDARGE_OUTOFMEMORYE_UNEXPECTEDE_FAIL に加えて、次の値を返すことがあります。

Return code Description
S_OK
メソッドは正常に完了しました。
REGDB_E_CLASSNOTREG
rclsid で指定されたコンポーネントが COM コンポーネントとして登録されていません。

解説(Remarks)

Microsoft Distributed Transaction Coordinator が実行されておらず、かつオブジェクトがトランザクショナルである場合、オブジェクトは正常に作成されます。ただし、そのオブジェクトに対するメソッド呼び出しは CONTEXT_E_TMNOTAVAILABLE で失敗します。オブジェクトはこの状態から回復できないため、解放する必要があります。

Examples

ITransactionContextEx* pTransactionContext = NULL;
IMyObject* pMyObject = NULL;
HRESULT hr;

// Get TransactionContextEx.
hr = CoCreateInstance(CLSID_TransactionContextEx, 
  NULL, CLSCTX_INPROC, IID_ITransactionContextEx, 
  (void**)&pTransactionContext);
if (FAILED(hr)) throw(hr);

// Create an instance of MyObject.
hr = pTransactionContext->CreateInstance(CLSID_CMyObject, 
  IID_IMyObject, (void**)&pMyObject);
if (FAILED(hr)) throw(hr);

vtbl 4 HRESULT Commit()

現在のトランザクションに参加しているすべての COM オブジェクトの処理をコミットしようとします。トランザクションはこのメソッドから戻る時点で終了します。(ITransactionContextEx.Commit)

戻り値

このメソッドは、標準の戻り値 E_INVALIDARGE_OUTOFMEMORYE_UNEXPECTED に加えて、次の値を返すことがあります。

Return code Description
S_OK
トランザクションはコミットされました。
E_FAIL
TransactionContextEx オブジェクトが COM+ プロセス下で実行されていません。TransactionContextEx コンポーネントのレジストリエントリが破損している可能性があります。
CONTEXT_E_ABORTED
トランザクションはアボートされました。

解説(Remarks)

Commit を呼び出すと、トランザクションのコミットが試行されます。ただし、次の条件下ではトランザクションはアボートされます。

メソッドから戻る時点で、トランザクションがコミットされたかアボートされたかにかかわらず、トランザクションは終了します。

Examples

ITransactionContextEx::Abort の例を参照してください。

vtbl 5 HRESULT Abort()

現在のトランザクションに参加しているすべての COM オブジェクトの処理をアボートします。トランザクションはこのメソッドから戻る時点で終了します。(ITransactionContextEx.Abort)

戻り値

このメソッドは、標準の戻り値 E_INVALIDARGE_OUTOFMEMORYE_UNEXPECTED に加えて、次の値を返すことがあります。

Return code Description
S_OK
トランザクションはアボートされました。
E_FAIL
TransactionContextEx オブジェクトが COM+ プロセス下で実行されていません。TransactionContextEx コンポーネントのレジストリエントリが破損している可能性があります。

解説(Remarks)

Abort を呼び出すと、メソッドから戻る時点でトランザクションが終了し、参加中のすべてのオブジェクトが自動的に非アクティブ化されます。トランザクションに参加している各リソースマネージャーは、それらのオブジェクトのために実行された操作をロールバックします。

Examples

ITransactionContextEx* pTransactionContext = NULL;
IMyObject* pMyObject = NULL;
boolean bUserCanceled = FALSE;
HRESULT hr;

// Get TransactionContextEx.
hr = CoCreateInstance(CLSID_ITransactionContextEx, 
  NULL, CLSCTX_INPROC, IID_ITransactionContextEx, 
  (void**)&pTransactionContext);
if (FAILED(hr)) throw(hr);

// Create an instance of MyObject.
hr = pTransactionContext->CreateInstance(CLSID_CMyObject, 
  IID_IMyObject, (void**)&pMyObject);
if (FAILED(hr)) throw(hr);

// Do some work here.

// If something goes wrong, abort the transaction.
if (bUserCanceled) {
    hr = pTransactionContext->Abort();
    if (FAILED(hr)) throw(hr);

// Otherwise, commit it.
} else {
    hr = pTransactionContext->Commit();
    if (FAILED(hr)) throw(hr);
}

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ITransactionContextEx "{7999FC22-D3C6-11CF-ACAB-00A024A55AEF}"
#usecom global ITransactionContextEx IID_ITransactionContextEx "{5CB66670-D3D4-11CF-ACAB-00A024A55AEF}"
#comfunc global ITransactionContextEx_CreateInstance  3 var,var,sptr
#comfunc global ITransactionContextEx_Commit          4
#comfunc global ITransactionContextEx_Abort           5
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※#usecom 末尾は CoCreateInstance 用のクラスID(コクラスCLSID, SDKから自動取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。