Transaction.TransactionCompleted Event

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Indicates that the transaction is completed.

Namespace:   System.Transactions
Assembly:  System.Transactions (in System.Transactions.dll)

public event TransactionCompletedEventHandler TransactionCompleted

Exception Condition
ObjectDisposedException

An attempt to subscribe this event on a transaction that has been disposed.

You can register for this event instead of using a volatile enlistment to get outcome information for transactions. The parameter passed to the TransactionCompletedEventHandler delegate is a Transaction instance. You can then query the TransactionInformation property of the specific instance to get an instance of TransactionInformation, whose Status property contains the status of a transaction with either the Committed or Aborted value.

Caution   Signing up for this event negatively affects the performance of the transaction it is attached to.

The following sample shows how an application can obtain the outcome of a transaction by subscribing to the TransactionCompleted event.

static void Main(string[] args)
{
	try
	{
		//Create the transaction scope
		using (TransactionScope scope = new TransactionScope())
		{
			//Register for the transaction completed event for the current transaction
			Transaction.Current.TransactionCompleted += new TransactionCompletedEventHandler(Current_TransactionCompleted);

			//Call complete on the TransactionScope based on console input
			ConsoleKeyInfo c;
			while (true)
			{
				Console.Write("Complete the transaction scope? [Y|N] ");
				c = Console.ReadKey();
				Console.WriteLine();

				if ((c.KeyChar == 'Y') || (c.KeyChar == 'y'))
				{
					scope.Complete();
					break;
				}
				else if ((c.KeyChar == 'N') || (c.KeyChar == 'n'))
				{
					break;
				}
			}

		}

	}
	catch (System.Transactions.TransactionException ex)
	{
		Console.WriteLine(ex);
	}
	catch
	{
		Console.WriteLine("Cannot complete transaction");
		throw;
	}
}

//Transaction completed event handler
static void Current_TransactionCompleted(object sender, TransactionEventArgs e)
{
	Console.WriteLine("A transaction has completed:");
	Console.WriteLine("ID:             {0}", e.Transaction.TransactionInformation.LocalIdentifier);
	Console.WriteLine("Distributed ID: {0}", e.Transaction.TransactionInformation.DistributedIdentifier);
	Console.WriteLine("Status:         {0}", e.Transaction.TransactionInformation.Status);
	Console.WriteLine("IsolationLevel: {0}", e.Transaction.IsolationLevel);
}

.NET Framework
Available since 2.0
Return to top
Show: