SqlCommand.BeginExecuteNonQuery Metodo

public:
 IAsyncResult ^ BeginExecuteNonQuery();

public IAsyncResult BeginExecuteNonQuery ();

member this.BeginExecuteNonQuery : unit -> IAsyncResult

Public Function BeginExecuteNonQuery () As IAsyncResult

Restituisce

Oggetto IAsyncResult che può essere usato per eseguire il polling o attendere i risultati o entrambi. Questo valore è necessario anche quando si richiama EndExecuteNonQuery(IAsyncResult) , che restituisce il numero di righe interessate.

Eccezioni

- or -

<xref data-throw-if-not-resolved="true" uid="Microssoft.Data.SqlClient.SqlCommand.EnableOptimizedParameterBinding"></xref>
is set to true and a parameter with direction Output or InputOutput has been added to the <xref data-throw-if-not-resolved="true" uid="Microsoft.Data.SqlClient.SqlCommand.Parameters"></xref> collection.

Esempio

L'applicazione console seguente crea aggiornamenti dei dati all'interno del database di esempio AdventureWorks , eseguendo il proprio lavoro in modo asincrono. Per emulare un processo con esecuzione prolungata, in questo esempio viene inserita un'istruzione WAITFOR nel testo del comando. In genere, non si sarebbero necessari sforzi per rendere i comandi più lente, ma in questo caso è più facile illustrare il comportamento asincrono.

// <Snippet1>
using System;
using System.Data;
using Microsoft.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. 

        return "Data Source=(local);Integrated Security=SSPI;" +
            "Initial Catalog=AdventureWorks";
    }
}
// </Snippet1>

Commenti

Il BeginExecuteNonQuery metodo avvia il processo di esecuzione asincrona di un'istruzione Transact-SQL o di una stored procedure che non restituisce righe, in modo che altre attività possano essere eseguite simultaneamente durante l'esecuzione dell'istruzione. Al termine dell'istruzione, gli sviluppatori devono chiamare il EndExecuteNonQuery metodo per completare l'operazione. Il BeginExecuteNonQuery metodo restituisce immediatamente, ma fino a quando il codice esegue la chiamata al metodo corrispondente EndExecuteNonQuery , non deve eseguire altre chiamate che avviano un'esecuzione sincrona o asincrona sullo stesso SqlCommand oggetto. La chiamata all'oggetto EndExecuteNonQuery prima del completamento dell'esecuzione del comando causa SqlCommand il blocco dell'oggetto fino al termine dell'esecuzione.

Si noti che il testo e i parametri del comando vengono inviati al server in modo sincrono. Se viene inviato un comando di grandi dimensioni o molti parametri, questo metodo può bloccare durante le scritture. Dopo l'invio del comando, il metodo restituisce immediatamente senza attendere una risposta dal server, ovvero le letture sono asincrone.

Poiché questo overload non supporta una routine di callback, gli sviluppatori devono eseguire il polling per determinare se il comando è stato completato, usando la proprietà del metodo restituito dal metodo oppure attendere il completamento di uno o più comandi usando la IsCompletedAsyncWaitHandle proprietà dell'oggetto restituitoIAsyncResultBeginExecuteNonQuery.IAsyncResult

Questo metodo ignora la CommandTimeout proprietà.

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

Parametri

Restituisce

Oggetto IAsyncResult che può essere usato per eseguire il polling o attendere i risultati o entrambi. Questo valore è necessario anche quando si richiama EndExecuteNonQuery(IAsyncResult) , che restituisce il numero di righe interessate.

Eccezioni

- or -

<xref data-throw-if-not-resolved="true" uid="Microssoft.Data.SqlClient.SqlCommand.EnableOptimizedParameterBinding"></xref>
is set to true and a parameter with direction Output or InputOutput has been added to the <xref data-throw-if-not-resolved="true" uid="Microsoft.Data.SqlClient.SqlCommand.Parameters"></xref> collection.

Esempio

L'applicazione Windows seguente illustra l'uso del BeginExecuteNonQuery metodo, eseguendo un'istruzione Transact-SQL che include un ritardo di diversi secondi (simulando un comando a esecuzione prolungata).

In questo esempio vengono illustrate molte tecniche importanti. Ciò include la chiamata di un metodo che interagisce con il modulo da un thread separato. In questo esempio viene inoltre illustrato come impedire agli utenti di eseguire più volte un comando contemporaneamente e come assicurarsi che il modulo non venga chiuso prima che venga chiamata la procedura di callback.

Per impostare questo esempio, creare una nuova applicazione Windows. Inserire un controllo e un ButtonLabel controllo nel modulo (accettando il nome predefinito per ogni controllo). Aggiungere il codice seguente alla classe del modulo, modificando la stringa di connessione in base alle esigenze dell'ambiente.

// <Snippet1>
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Text;
using System.Windows.Forms;
using Microsoft.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. 

            return "Data Source=(local);Integrated Security=true;" +
                "Initial Catalog=AdventureWorks";
        }

        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();
                }
            }
        }
    }
}
// </Snippet1>

Commenti

Il BeginExecuteNonQuery metodo avvia il processo di esecuzione asincrona di un'istruzione Transact-SQL o di una stored procedure che non restituisce righe, in modo che altre attività possano essere eseguite simultaneamente durante l'esecuzione dell'istruzione. Al termine dell'istruzione, gli sviluppatori devono chiamare il EndExecuteNonQuery metodo per completare l'operazione. Il BeginExecuteNonQuery metodo restituisce immediatamente, ma fino a quando il codice esegue la chiamata al metodo corrispondente EndExecuteNonQuery , non deve eseguire altre chiamate che avviano un'esecuzione sincrona o asincrona sullo stesso SqlCommand oggetto. La chiamata all'oggetto EndExecuteNonQuery prima del completamento dell'esecuzione del comando causa SqlCommand il blocco dell'oggetto fino al termine dell'esecuzione.

Il callback parametro consente di specificare un AsyncCallback delegato chiamato al termine dell'istruzione. È possibile chiamare il EndExecuteNonQuery metodo dall'interno di questa procedura delegata o da qualsiasi altra posizione all'interno dell'applicazione. È inoltre possibile passare qualsiasi oggetto nel asyncStateObject parametro e la procedura di callback può recuperare queste informazioni usando la AsyncState proprietà .

Si noti che il testo e i parametri del comando vengono inviati al server in modo sincrono. Se viene inviato un comando di grandi dimensioni o molti parametri, questo metodo può bloccare durante le scritture. Dopo l'invio del comando, il metodo restituisce immediatamente senza attendere una risposta dal server, ovvero le letture sono asincrone.

Poiché la procedura di callback viene eseguita dall'interno di un thread in background fornito da Microsoft .NET Common Language Runtime, è molto importante adottare un approccio rigoroso per gestire le interazioni tra thread dall'interno delle applicazioni. Ad esempio, non è necessario interagire con il contenuto di un modulo dall'interno della procedura di callback; dovrebbe essere necessario aggiornare il modulo, è necessario tornare al thread del modulo per eseguire il lavoro. L'esempio in questo argomento illustra questo comportamento.

Tutti gli errori che si verificano durante l'esecuzione dell'operazione vengono generati come eccezioni nella procedura di callback. È necessario gestire l'eccezione nella procedura di callback, non nell'applicazione principale. Per altre informazioni sulla gestione delle eccezioni nella procedura di callback, vedere l'esempio in questo argomento.

Questo metodo ignora la CommandTimeout proprietà.