Transaction.TransactionCompleted Event

Definition

Namespace:

System.Transactions

Assembly:

System.Transactions.Local.dll

Source:

Transaction.cs

Indicates that the transaction is completed.

public:
 event System::Transactions::TransactionCompletedEventHandler ^ TransactionCompleted;

public event System.Transactions.TransactionCompletedEventHandler? TransactionCompleted;

member this.TransactionCompleted : System.Transactions.TransactionCompletedEventHandler 

Public Custom Event TransactionCompleted As TransactionCompletedEventHandler 

Event Type

TransactionCompletedEventHandler

Exceptions

ObjectDisposedException

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

Examples

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);
}

Public Shared Sub Main()
    Try
        Using scope As TransactionScope = New TransactionScope()

            'Register for the transaction completed event for the current transaction
            AddHandler Transaction.Current.TransactionCompleted, AddressOf Current_TransactionCompleted

            'Perform transactional work here.

            'Call complete on the TransactionScope based on console input
            Dim c As ConsoleKeyInfo
            While (True)

                Console.Write("Complete the transaction scope? [Y|N] ")
                c = Console.ReadKey()
                Console.WriteLine()
                If (c.KeyChar = "Y") Or (c.KeyChar = "y") Then
                    scope.Complete()
                    Exit While
                ElseIf ((c.KeyChar = "N") Or (c.KeyChar = "n")) Then
                    Exit While
                End If
                
            End While

        End Using
    Catch ex As TransactionException
        Console.WriteLine(ex)
    Catch
        Console.WriteLine("Cannot complete transaction")
        Throw
    End Try
End Sub

'Transaction completed event handler
Private Shared Sub Current_TransactionCompleted(ByVal sender As Object, ByVal e As TransactionEventArgs)
    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)
End Sub

Remarks

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.