SqlCommand.BeginExecuteNonQuery Methode

public:
 IAsyncResult ^ BeginExecuteNonQuery();

public IAsyncResult BeginExecuteNonQuery();

member this.BeginExecuteNonQuery : unit -> IAsyncResult

Public Function BeginExecuteNonQuery () As IAsyncResult

Retouren

Een IAsyncResult die kan worden gebruikt om resultaten te peilen of te wachten, of beide; deze waarde is ook nodig bij het aanroepen EndExecuteNonQuery(IAsyncResult), waarmee het aantal betrokken rijen wordt geretourneerd.

Uitzonderingen

Voorbeelden

De volgende consoletoepassing maakt updates van gegevens in de Voorbeelddatabase AdventureWorks , die het werk asynchroon uitvoert. Als u een langlopend proces wilt emuleren, wordt in dit voorbeeld een WAITFOR-instructie ingevoegd in de opdrachttekst. Normaal gesproken voert u geen inspanningen uit om uw opdrachten langzamer uit te voeren, maar dit in dit geval maakt het gemakkelijker om het asynchrone gedrag te demonstreren.

using System.Data.SqlClient;

class Class1
{
    static void Main()
    {
        // This is a simple example that demonstrates the usage of the
        // BeginExecuteNonQuery functionality.
        // The WAITFOR statement simply adds enough time to prove the
        // asynchronous nature of the command.

        string commandText =
            "UPDATE Production.Product SET ReorderPoint = ReorderPoint + 1 " +
            "WHERE ReorderPoint Is Not Null;" +
            "WAITFOR DELAY '0:0:3';" +
            "UPDATE Production.Product SET ReorderPoint = ReorderPoint - 1 " +
            "WHERE ReorderPoint Is Not Null";

        RunCommandAsynchronously(commandText, GetConnectionString());

        Console.WriteLine("Press ENTER to continue.");
        Console.ReadLine();
    }

    private static void RunCommandAsynchronously(
        string commandText, string connectionString)
    {
        // Given command text and connection string, asynchronously execute
        // the specified command against the connection. For this example,
        // the code displays an indicator as it is working, verifying the
        // asynchronous behavior.
        using (SqlConnection connection =
                   new SqlConnection(connectionString))
        {
            try
            {
                int count = 0;
                SqlCommand command = new SqlCommand(commandText, connection);
                connection.Open();

                IAsyncResult result = command.BeginExecuteNonQuery();
                while (!result.IsCompleted)
                {
                    Console.WriteLine("Waiting ({0})", count++);
                    // Wait for 1/10 second, so the counter
                    // does not consume all available resources
                    // on the main thread.
                    System.Threading.Thread.Sleep(100);
                }
                Console.WriteLine("Command complete. Affected {0} rows.",
                    command.EndExecuteNonQuery(result));
            }
            catch (SqlException ex)
            {
                Console.WriteLine("Error ({0}): {1}", ex.Number, ex.Message);
            }
            catch (InvalidOperationException ex)
            {
                Console.WriteLine("Error: {0}", ex.Message);
            }
            catch (Exception ex)
            {
                // You might want to pass these errors
                // back out to the caller.
                Console.WriteLine("Error: {0}", ex.Message);
            }
        }
    }

    private static string GetConnectionString()
    {
        // To avoid storing the connection string in your code,
        // you can retrieve it from a configuration file.

        // If you have not included "Asynchronous Processing=true" in the
        // connection string, the command is not able
        // to execute asynchronously.
        return "Data Source=(local);Integrated Security=SSPI;" +
            "Initial Catalog=AdventureWorks; Asynchronous Processing=true";
    }
}

Imports System.Data.SqlClient

Module Module1

    Sub Main()
        ' This is a simple example that demonstrates the usage of the 
        ' BeginExecuteNonQuery functionality.
        ' The WAITFOR statement simply adds enough time to prove the 
        ' asynchronous nature of the command.
        Dim commandText As String =
         "UPDATE Production.Product SET ReorderPoint = ReorderPoint + 1 " &
         "WHERE ReorderPoint Is Not Null;" &
         "WAITFOR DELAY '0:0:3';" &
         "UPDATE Production.Product SET ReorderPoint = ReorderPoint - 1 " &
         "WHERE ReorderPoint Is Not Null"

        RunCommandAsynchronously(commandText, GetConnectionString())

        Console.WriteLine("Press ENTER to continue.")
        Console.ReadLine()
    End Sub

    Private Sub RunCommandAsynchronously(
     ByVal commandText As String, ByVal connectionString As String)

        ' Given command text and connection string, asynchronously execute
        ' the specified command against the connection. For this example,
        ' the code displays an indicator as it is working, verifying the 
        ' asynchronous behavior. 
        Using connection As New SqlConnection(connectionString)
            Try
                Dim count As Integer = 0
                Dim command As New SqlCommand(commandText, connection)
                connection.Open()
                Dim result As IAsyncResult = command.BeginExecuteNonQuery()
                While Not result.IsCompleted
                    Console.WriteLine("Waiting ({0})", count)
                    ' Wait for 1/10 second, so the counter
                    ' does not consume all available resources 
                    ' on the main thread.
                    Threading.Thread.Sleep(100)
                    count += 1
                End While
                Console.WriteLine("Command complete. Affected {0} rows.",
                    command.EndExecuteNonQuery(result))
            Catch ex As SqlException
                Console.WriteLine("Error ({0}): {1}", ex.Number, ex.Message)
            Catch ex As InvalidOperationException
                Console.WriteLine("Error: {0}", ex.Message)
            Catch ex As Exception
                ' You might want to pass these errors
                ' back out to the caller.
                Console.WriteLine("Error: {0}", ex.Message)
            End Try
        End Using
    End Sub

    Private Function GetConnectionString() As String
        ' To avoid storing the connection string in your code,            
        ' you can retrieve it from a configuration file. 

        ' If you have not included "Asynchronous Processing=true" in the
        ' connection string, the command is not able
        ' to execute asynchronously.
        Return "Data Source=(local);Integrated Security=SSPI;" &
          "Initial Catalog=AdventureWorks; Asynchronous Processing=true"
    End Function
End Module

Opmerkingen

De methode BeginExecuteNonQuery start het proces van het asynchroon uitvoeren van een Transact-SQL-instructie of opgeslagen procedure die geen rijen retourneert, zodat andere taken gelijktijdig kunnen worden uitgevoerd terwijl de instructie wordt uitgevoerd. Wanneer de instructie is voltooid, moeten ontwikkelaars de EndExecuteNonQuery methode aanroepen om de bewerking te voltooien. De BeginExecuteNonQuery methode retourneert onmiddellijk, maar totdat de code de bijbehorende EndExecuteNonQuery methodeaanroep uitvoert, mag deze geen andere aanroepen uitvoeren die een synchrone of asynchrone uitvoering starten op hetzelfde SqlCommand object. Als u de uitvoering van de EndExecuteNonQuery opdracht aanroept, wordt het SqlCommand object geblokkeerd totdat de uitvoering is voltooid.

Houd er rekening mee dat de opdrachttekst en -parameters synchroon naar de server worden verzonden. Als een grote opdracht of veel parameters worden verzonden, kan deze methode tijdens schrijfbewerkingen blokkeren. Nadat de opdracht is verzonden, wordt de methode onmiddellijk geretourneerd zonder te wachten op een antwoord van de server. Leesbewerkingen zijn asynchroon.

Omdat deze overbelasting geen callback-procedure ondersteunt, moeten ontwikkelaars pollen om te bepalen of de opdracht is voltooid, met behulp van de IsCompleted eigenschap van de IAsyncResult geretourneerde BeginExecuteNonQuery methode; of wachten totdat een of meer opdrachten zijn voltooid met behulp van de AsyncWaitHandle eigenschap van de geretourneerde IAsyncResult.

Met deze methode wordt de CommandTimeout eigenschap genegeerd.

Zie ook

• Verbinding maken en ophalen van gegevens in ADO.NET
• Using the .NET Framework Data Provider for SQL Server
• overzicht van ADO.NET

public:
 IAsyncResult ^ BeginExecuteNonQuery(AsyncCallback ^ callback, System::Object ^ stateObject);

public IAsyncResult BeginExecuteNonQuery(AsyncCallback callback, object stateObject);

member this.BeginExecuteNonQuery : AsyncCallback * obj -> IAsyncResult

Public Function BeginExecuteNonQuery (callback As AsyncCallback, stateObject As Object) As IAsyncResult

Parameters

Retouren

Een IAsyncResult die kan worden gebruikt om resultaten te peilen of te wachten, of beide; deze waarde is ook nodig bij het aanroepen EndExecuteNonQuery(IAsyncResult), waarmee het aantal betrokken rijen wordt geretourneerd.

Uitzonderingen

Voorbeelden

In de volgende Windows toepassing ziet u het gebruik van de methode BeginExecuteNonQuery, waarbij een Transact-SQL-instructie wordt uitgevoerd die een vertraging van enkele seconden bevat (een langlopende opdracht emuleren).

In dit voorbeeld ziet u een groot aantal belangrijke technieken. Dit omvat het aanroepen van een methode die interactie heeft met het formulier vanuit een afzonderlijke thread. Daarnaast laat dit voorbeeld zien hoe u gebruikers moet blokkeren om meerdere keren tegelijk een opdracht uit te voeren en hoe u ervoor moet zorgen dat het formulier niet wordt gesloten voordat de callback-procedure wordt aangeroepen.

Als u dit voorbeeld wilt instellen, maakt u een nieuwe Windows-toepassing. Plaats een Button besturingselement en een Label besturingselement op het formulier (waarbij de standaardnaam voor elk besturingselement wordt geaccepteerd). Voeg de volgende code toe aan de klasse van het formulier en wijzig de verbindingsreeks indien nodig voor uw omgeving.

using System.Data.SqlClient;

namespace Microsoft.AdoDotNet.CodeSamples
{
    public partial class Form1 : Form
    {
        public Form1()
        {
            InitializeComponent();
        }

        // Hook up the form's Load event handler (you can double-click on
        // the form's design surface in Visual Studio), and then add
        // this code to the form's class:
        private void Form1_Load(object sender, EventArgs e)
        {
            this.button1.Click += new System.EventHandler(this.button1_Click);
            this.FormClosing += new System.Windows.Forms.
                FormClosingEventHandler(this.Form1_FormClosing);
        }

        // You need this delegate in order to display text from a thread
        // other than the form's thread. See the HandleCallback
        // procedure for more information.
        // This same delegate matches both the DisplayStatus
        // and DisplayResults methods.
        private delegate void DisplayInfoDelegate(string Text);

        // This flag ensures that the user does not attempt
        // to restart the command or close the form while the
        // asynchronous command is executing.
        private bool isExecuting;

        // This example maintains the connection object
        // externally, so that it is available for closing.
        private SqlConnection connection;

        private static string GetConnectionString()
        {
            // To avoid storing the connection string in your code,
            // you can retrieve it from a configuration file.

            // If you have not included "Asynchronous Processing=true" in the
            // connection string, the command is not able
            // to execute asynchronously.
            return "Data Source=(local);Integrated Security=true;" +
                "Initial Catalog=AdventureWorks; Asynchronous Processing=true";
        }

        private void DisplayStatus(string Text)
        {
            this.label1.Text = Text;
        }

        private void DisplayResults(string Text)
        {
            this.label1.Text = Text;
            DisplayStatus("Ready");
        }

        private void Form1_FormClosing(object sender,
            System.Windows.Forms.FormClosingEventArgs e)
        {
            if (isExecuting)
            {
                MessageBox.Show(this, "Cannot close the form until " +
                    "the pending asynchronous command has completed. Please wait...");
                e.Cancel = true;
            }
        }

        private void button1_Click(object sender, System.EventArgs e)
        {
            if (isExecuting)
            {
                MessageBox.Show(this,
                    "Already executing. Please wait until the current query " +
                    "has completed.");
            }
            else
            {
                SqlCommand command = null;
                try
                {
                    DisplayResults("");
                    DisplayStatus("Connecting...");
                    connection = new SqlConnection(GetConnectionString());
                    // To emulate a long-running query, wait for
                    // a few seconds before working with the data.
                    // This command does not do much, but that's the point--
                    // it does not change your data, in the long run.
                    string commandText =
                        "WAITFOR DELAY '0:0:05';" +
                        "UPDATE Production.Product SET ReorderPoint = ReorderPoint + 1 " +
                        "WHERE ReorderPoint Is Not Null;" +
                        "UPDATE Production.Product SET ReorderPoint = ReorderPoint - 1 " +
                        "WHERE ReorderPoint Is Not Null";

                    command = new SqlCommand(commandText, connection);
                    connection.Open();

                    DisplayStatus("Executing...");
                    isExecuting = true;
                    // Although it is not required that you pass the
                    // SqlCommand object as the second parameter in the
                    // BeginExecuteNonQuery call, doing so makes it easier
                    // to call EndExecuteNonQuery in the callback procedure.
                    AsyncCallback callback = new AsyncCallback(HandleCallback);
                    command.BeginExecuteNonQuery(callback, command);
                }
                catch (Exception ex)
                {
                    isExecuting = false;
                    DisplayStatus(string.Format("Ready (last error: {0})", ex.Message));
                    if (connection != null)
                    {
                        connection.Close();
                    }
                }
            }
        }

        private void HandleCallback(IAsyncResult result)
        {
            try
            {
                // Retrieve the original command object, passed
                // to this procedure in the AsyncState property
                // of the IAsyncResult parameter.
                SqlCommand command = (SqlCommand)result.AsyncState;
                int rowCount = command.EndExecuteNonQuery(result);
                string rowText = " rows affected.";
                if (rowCount == 1)
                {
                    rowText = " row affected.";
                }
                rowText = rowCount + rowText;

                // You may not interact with the form and its contents
                // from a different thread, and this callback procedure
                // is all but guaranteed to be running from a different thread
                // than the form. Therefore you cannot simply call code that
                // displays the results, like this:
                // DisplayResults(rowText)

                // Instead, you must call the procedure from the form's thread.
                // One simple way to accomplish this is to call the Invoke
                // method of the form, which calls the delegate you supply
                // from the form's thread.
                DisplayInfoDelegate del = new DisplayInfoDelegate(DisplayResults);
                this.Invoke(del, rowText);
            }
            catch (Exception ex)
            {
                // Because you are now running code in a separate thread,
                // if you do not handle the exception here, none of your other
                // code catches the exception. Because none of
                // your code is on the call stack in this thread, there is nothing
                // higher up the stack to catch the exception if you do not
                // handle it here. You can either log the exception or
                // invoke a delegate (as in the non-error case in this
                // example) to display the error on the form. In no case
                // can you simply display the error without executing a delegate
                // as in the try block here.

                // You can create the delegate instance as you
                // invoke it, like this:
                this.Invoke(new DisplayInfoDelegate(DisplayStatus),
                    String.Format("Ready(last error: {0}", ex.Message));
            }
            finally
            {
                isExecuting = false;
                if (connection != null)
                {
                    connection.Close();
                }
            }
        }
    }
}

Imports System.Data.SqlClient
Imports System.Windows.Forms

Public Class Form1
    ' Add this code to the form's class:
    ' You need this delegate in order to display text from a thread
    ' other than the form's thread. See the HandleCallback
    ' procedure for more information.
    ' This same delegate matches both the DisplayStatus 
    ' and DisplayResults methods.
    Private Delegate Sub DisplayInfoDelegate(ByVal Text As String)

    ' This flag ensures that the user does not attempt
    ' to restart the command or close the form while the 
    ' asynchronous command is executing.
    Private isExecuting As Boolean

    ' This example maintains the connection object 
    ' externally, so that it is available for closing.
    Private connection As SqlConnection

    Private Function GetConnectionString() As String
        ' To avoid storing the connection string in your code,            
        ' you can retrieve it from a configuration file. 

        ' If you have not included "Asynchronous Processing=true" in the
        ' connection string, the command is not able
        ' to execute asynchronously.
        Return "Data Source=(local);Integrated Security=true;" &
          "Initial Catalog=AdventureWorks; Asynchronous Processing=true"
    End Function

    Private Sub DisplayStatus(ByVal Text As String)
        Me.Label1.Text = Text
    End Sub

    Private Sub DisplayResults(ByVal Text As String)
        Me.Label1.Text = Text
        DisplayStatus("Ready")
    End Sub

    Private Sub Form1_FormClosing(ByVal sender As Object,
        ByVal e As FormClosingEventArgs) _
        Handles Me.FormClosing
        If isExecuting Then
            MessageBox.Show(Me, "Cannot close the form until " &
                "the pending asynchronous command has completed. Please wait...")
            e.Cancel = True
        End If
    End Sub

    Private Sub Button1_Click(ByVal sender As System.Object,
        ByVal e As System.EventArgs) Handles Button1.Click
        If isExecuting Then
            MessageBox.Show(Me,
               "Already executing. Please wait until the current query " &
                "has completed.")
        Else
            Dim command As SqlCommand
            Try
                DisplayResults("")
                DisplayStatus("Connecting...")
                connection = New SqlConnection(GetConnectionString())
                ' To emulate a long-running query, wait for 
                ' a few seconds before working with the data.
                ' This command does not do much, but that's the point--
                ' it does not change your data, in the long run.
                Dim commandText As String =
                    "WAITFOR DELAY '0:0:05';" &
                    "UPDATE Production.Product SET ReorderPoint = ReorderPoint + 1 " &
                    "WHERE ReorderPoint Is Not Null;" &
                    "UPDATE Production.Product SET ReorderPoint = ReorderPoint - 1 " &
                    "WHERE ReorderPoint Is Not Null"

                command = New SqlCommand(commandText, connection)
                connection.Open()

                DisplayStatus("Executing...")
                isExecuting = True
                ' Although it is not required that you pass the 
                ' SqlCommand object as the second parameter in the 
                ' BeginExecuteNonQuery call, doing so makes it easier
                ' to call EndExecuteNonQuery in the callback procedure.
                Dim callback As New AsyncCallback(AddressOf HandleCallback)
                command.BeginExecuteNonQuery(callback, command)

            Catch ex As Exception
                isExecuting = False
                DisplayStatus(String.Format("Ready (last error: {0})", ex.Message))
                If connection IsNot Nothing Then
                    connection.Close()
                End If
            End Try
        End If
    End Sub

    Private Sub HandleCallback(ByVal result As IAsyncResult)
        Try
            ' Retrieve the original command object, passed
            ' to this procedure in the AsyncState property
            ' of the IAsyncResult parameter.
            Dim command As SqlCommand = CType(result.AsyncState, SqlCommand)
            Dim rowCount As Integer = command.EndExecuteNonQuery(result)
            Dim rowText As String = " rows affected."
            If rowCount = 1 Then
                rowText = " row affected."
            End If
            rowText = rowCount & rowText

            ' You may not interact with the form and its contents
            ' from a different thread, and this callback procedure
            ' is all but guaranteed to be running from a different thread
            ' than the form. Therefore you cannot simply call code that 
            ' displays the results, like this:
            ' DisplayResults(rowText)

            ' Instead, you must call the procedure from the form's thread.
            ' One simple way to accomplish this is to call the Invoke
            ' method of the form, which calls the delegate you supply
            ' from the form's thread. 
            Dim del As New DisplayInfoDelegate(AddressOf DisplayResults)
            Me.Invoke(del, rowText)

        Catch ex As Exception
            ' Because you are now running code in a separate thread, 
            ' if you do not handle the exception here, none of your other
            ' code catches the exception. Because none of your code
            ' is on the call stack in this thread, there is nothing
            ' higher up the stack to catch the exception if you do not 
            ' handle it here. You can either log the exception or 
            ' invoke a delegate (as in the non-error case in this 
            ' example) to display the error on the form. In no case
            ' can you simply display the error without executing a delegate
            ' as in the Try block here. 

            ' You can create the delegate instance as you 
            ' invoke it, like this:
            Me.Invoke(New DisplayInfoDelegate(AddressOf DisplayStatus),
                String.Format("Ready(last error: {0}", ex.Message))
        Finally
            isExecuting = False
            If connection IsNot Nothing Then
                connection.Close()
            End If
        End Try
    End Sub
End Class

Opmerkingen

De methode BeginExecuteNonQuery start het proces van het asynchroon uitvoeren van een Transact-SQL-instructie of opgeslagen procedure die geen rijen retourneert, zodat andere taken gelijktijdig kunnen worden uitgevoerd terwijl de instructie wordt uitgevoerd. Wanneer de instructie is voltooid, moeten ontwikkelaars de EndExecuteNonQuery methode aanroepen om de bewerking te voltooien. De BeginExecuteNonQuery methode retourneert onmiddellijk, maar totdat de code de bijbehorende EndExecuteNonQuery methodeaanroep uitvoert, mag deze geen andere aanroepen uitvoeren die een synchrone of asynchrone uitvoering starten op hetzelfde SqlCommand object. Als u de uitvoering van de EndExecuteNonQuery opdracht aanroept, wordt het SqlCommand object geblokkeerd totdat de uitvoering is voltooid.

callback Met de parameter kunt u een AsyncCallback gemachtigde opgeven die wordt aangeroepen wanneer de instructie is voltooid. U kunt de EndExecuteNonQuery methode aanroepen vanuit deze gedelegeerde procedure of vanaf een andere locatie in uw toepassing. Bovendien kunt u elk object in de asyncStateObject parameter doorgeven en de callback-procedure kan deze informatie ophalen met behulp van de AsyncState eigenschap.

Houd er rekening mee dat de opdrachttekst en -parameters synchroon naar de server worden verzonden. Als een grote opdracht of veel parameters worden verzonden, kan deze methode tijdens schrijfbewerkingen blokkeren. Nadat de opdracht is verzonden, wordt de methode onmiddellijk geretourneerd zonder te wachten op een antwoord van de server. Leesbewerkingen zijn asynchroon.

Omdat de callback-procedure wordt uitgevoerd vanuit een achtergrondthread die wordt geleverd door de Microsoft .NET algemene taalruntime, is het erg belangrijk dat u een strikte benadering neemt voor het afhandelen van crossthreadinteracties vanuit uw toepassingen. U mag bijvoorbeeld niet communiceren met de inhoud van een formulier vanuit uw callbackprocedure; als u het formulier moet bijwerken, moet u teruggaan naar de thread van het formulier om uw werk te kunnen doen. In het voorbeeld in dit onderwerp ziet u dit gedrag.

Alle fouten die optreden tijdens de uitvoering van de bewerking, worden gegenereerd als uitzonderingen in de callback-procedure. U moet de uitzondering in de callback-procedure afhandelen, niet in de hoofdtoepassing. Zie het voorbeeld in dit onderwerp voor meer informatie over het verwerken van uitzonderingen in de callback-procedure.

Met deze methode wordt de CommandTimeout eigenschap genegeerd.

Zie ook

• Verbinding maken en ophalen van gegevens in ADO.NET
• Using the .NET Framework Data Provider for SQL Server
• overzicht van ADO.NET