TransactionScope.Complete Méthode

Définition

Espace de noms:

System.Transactions

Assembly:

System.Transactions.Local.dll

Source:

TransactionScope.cs

Indique que toutes les opérations dans la portée sont terminées avec succès.

public:
 void Complete();

public void Complete ();

member this.Complete : unit -> unit

Public Sub Complete ()

Exceptions

InvalidOperationException

Cette méthode a déjà été appelée une fois.

Exemples

L’exemple suivant montre comment utiliser la TransactionScope classe pour définir un bloc de code pour participer à une transaction.

// 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.
static public int CreateTransactionScope(
    string connectString1, string connectString2,
    string commandText1, string commandText2)
{
    // Initialize the return value to zero and create a StringWriter to display results.
    int returnValue = 0;
    System.IO.StringWriter writer = new System.IO.StringWriter();

    try
    {
        // Create the TransactionScope to execute the commands, guaranteeing
        // that both commands can commit or roll back as a single unit of work.
        using (TransactionScope scope = new TransactionScope())
        {
            using (SqlConnection connection1 = new SqlConnection(connectString1))
            {
                // Opening the connection automatically enlists it in the 
                // TransactionScope as a lightweight transaction.
                connection1.Open();

                // Create the SqlCommand object and execute the first command.
                SqlCommand command1 = 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 (SqlConnection connection2 = new SqlConnection(connectString2))
                {
                    // The transaction is escalated to a full distributed
                    // transaction when connection2 is opened.
                    connection2.Open();

                    // Execute the second command in the second database.
                    returnValue = 0;
                    SqlCommand command2 = new SqlCommand(commandText2, connection2);
                    returnValue = command2.ExecuteNonQuery();
                    writer.WriteLine("Rows to be affected by command2: {0}", returnValue);
                }
            }

            // The Complete method commits the transaction. If an exception has been thrown,
            // Complete is not  called and the transaction is rolled back.
            scope.Complete();
        }
    }
    catch (TransactionAbortedException ex)
    {
        writer.WriteLine("TransactionAbortedException Message: {0}", ex.Message);
    }

    // Display messages.
    Console.WriteLine(writer.ToString());

    return returnValue;
}

'  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

    Try
    ' 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.
                connection1.Open()

                ' 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.
                    connection2.Open()

                    ' 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.
        scope.Complete()
        End Using
    Catch ex As TransactionAbortedException
        writer.WriteLine("TransactionAbortedException Message: {0}", ex.Message)
    End Try

    ' Display messages.
    Console.WriteLine(writer.ToString())

    Return returnValue
End Function

Remarques

Lorsque vous êtes convaincu que toutes les opérations dans l’étendue sont terminées avec succès, vous ne devez appeler cette méthode qu’une seule fois pour informer le gestionnaire de transactions que l’état de toutes les ressources est cohérent et que la transaction peut être validée. Il est très recommandé de placer l’appel comme dernière instruction du using bloc.

Pour plus d’informations sur la façon dont cette méthode est utilisée, consultez la rubrique Implémentation d’une transaction implicite à l’aide de l’étendue de transaction .

L’échec de l’appel de cette méthode abandonne la transaction, car le gestionnaire de transactions l’interprète comme une défaillance du système ou des exceptions levées dans l’étendue de la transaction. Toutefois, vous devez également noter que l’appel de cette méthode ne garantit pas la validation de la transaction. Il s’agit simplement d’un moyen d’informer le gestionnaire de transactions de votre état. Après avoir appelé cette méthode, vous ne pouvez plus accéder à la transaction ambiante via la Current propriété , et si vous essayez de le faire, une exception est levée.

Le travail réel de validation entre le gestionnaire de ressources se produit au niveau de l’instruction End Using si l’objet TransactionScope a créé la transaction. S'il n'a pas créé la transaction, la validation se produit chaque fois que Commit est appelé par le propriétaire de l'objet CommittableTransaction. À ce stade, le Gestionnaire de transactions appelle les gestionnaires de ressources et les informe de la validation ou de la restauration, selon que cette méthode a été appelée sur l’objet TransactionScope .

Voir aussi

• Implémentation d’une transaction implicite à l’aide de l’étendue de transaction