This documentation is archived and is not being maintained.

Transaction.TransactionCompleted Event

Indicates that the transaction is completed.

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

public event TransactionCompletedEventHandler TransactionCompleted

ExceptionCondition
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

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: