This documentation is archived and is not being maintained.

TransactionScope::Complete Method

Indicates that all operations within the scope are completed successfully.

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

void Complete()


This method has already been called once.

When you are satisfied that all operations within the scope are completed successfully, you should call this method only once to inform that transaction manager that the state across all resources is consistent, and the transaction can be committed. It is very good practice to put the call as the last statement in the using block.

For more information on how this method is used, see the Implementing An Implicit Transaction Using Transaction Scope topic.

Failing to call this method aborts the transaction, because the transaction manager interprets this as a system failure, or exceptions thrown within the scope of transaction. However, you should also note that calling this method does not guarantee a commit of the transaction. It is merely a way of informing the transaction manager of your status. After calling this method, you can no longer access the ambient transaction via the Current property, and trying to do so results in an exception being thrown.

The actual work of commit between the resources manager happens at the End Using statement if the TransactionScope object created the transaction. If it did not create the transaction, the commit occurs whenever Commit is called by the owner of the CommittableTransaction object. At that point the Transaction Manager calls the resource managers and informs them to either commit or rollback, based on whether this method was called on the TransactionScope object.

The following example demonstrates how to use the TransactionScope class to define a block of code to participate in a transaction.

No code example is currently available or this language may not be supported.
'  This function takes arguments for 2 connection strings and commands to create a transaction  
'  involving two SQL Servers. It returns a value > 0 if the transaction is committed, 0 if the  
'  transaction is rolled back. To test this code, you can connect to two different databases  
'  on the same server by altering the connection string, or to another 3rd party RDBMS   
'  by altering the code in the connection2 code block. 
Public Function CreateTransactionScope( _
  ByVal connectString1 As String, ByVal connectString2 As String, _
  ByVal commandText1 As String, ByVal commandText2 As String) As Integer 

    ' Initialize the return value to zero and create a StringWriter to display results. 
    Dim returnValue As Integer = 0
    Dim writer As System.IO.StringWriter = New System.IO.StringWriter

    ' Create the TransactionScope to execute the commands, guaranteeing 
    '  that both commands can commit or roll back as a single unit of work. 
        Using scope As New TransactionScope()
            Using connection1 As New SqlConnection(connectString1)
                ' Opening the connection automatically enlists it in the  
                ' TransactionScope as a lightweight transaction.

                ' Create the SqlCommand object and execute the first command. 
                Dim command1 As SqlCommand = New SqlCommand(commandText1, connection1)
                returnValue = command1.ExecuteNonQuery()
                writer.WriteLine("Rows to be affected by command1: {0}", returnValue)

                ' If you get here, this means that command1 succeeded. By nesting 
                ' the using block for connection2 inside that of connection1, you 
                ' conserve server and network resources as connection2 is opened 
                ' only when there is a chance that the transaction can commit.    
                Using connection2 As New SqlConnection(connectString2)
                    ' The transaction is escalated to a full distributed 
                    ' transaction when connection2 is opened.

                    ' Execute the second command in the second database.
                    returnValue = 0
                    Dim command2 As SqlCommand = New SqlCommand(commandText2, connection2)
                    returnValue = command2.ExecuteNonQuery()
                    writer.WriteLine("Rows to be affected by command2: {0}", returnValue)
                End Using 
            End Using 

        ' The Complete method commits the transaction. If an exception has been thrown, 
        ' Complete is called and the transaction is rolled back.
        End Using 
    Catch ex As TransactionAbortedException
        writer.WriteLine("TransactionAbortedException Message: {0}", ex.Message)
    Catch ex As ApplicationException
        writer.WriteLine("ApplicationException Message: {0}", ex.Message)
    End Try 

    ' Display messages.

    Return returnValue
End Function

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