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)

'Declaration
Public Event TransactionCompleted As TransactionCompletedEventHandler
'Usage
Dim instance As Transaction 
Dim handler As TransactionCompletedEventHandler 

AddHandler instance.TransactionCompleted, handler

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.

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
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

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0
Show: