Condividi tramite


SqlCommand.BeginExecuteReader Metodo

Definizione

Avvia l'esecuzione asincrona dell'istruzione Transact-SQL o della stored procedure descritta da SqlCommand e recupera uno o più set di risultati dal server.

Overload

BeginExecuteReader()

Avvia l'esecuzione asincrona dell'istruzione Transact-SQL o della stored procedure descritta da SqlCommand e recupera uno o più set di risultati dal server.

BeginExecuteReader(CommandBehavior)

Avvia l'esecuzione asincrona dell'istruzione Transact-SQL o della stored procedure descritta dall'oggetto SqlCommand usando uno dei valori CommandBehavior.

BeginExecuteReader(AsyncCallback, Object)

Avvia l'esecuzione asincrona dell'istruzione Transact-SQL o della stored procedure descritta dall'oggetto SqlCommand e recupera uno o più set di risultati dal server, in base alla routine di callback e alle informazioni sullo stato.

BeginExecuteReader(AsyncCallback, Object, CommandBehavior)

Avvia l'esecuzione asincrona dell'istruzione o della stored procedure Transact-SQL descritta da SqlCommand, usando uno dei valori di CommandBehavior e recuperando uno o più set di risultati dal server, in base a una routine di callback e alle informazioni sullo stato.

BeginExecuteReader()

Avvia l'esecuzione asincrona dell'istruzione Transact-SQL o della stored procedure descritta da SqlCommand e recupera uno o più set di risultati dal server.

public:
 IAsyncResult ^ BeginExecuteReader();
public IAsyncResult BeginExecuteReader ();
member this.BeginExecuteReader : unit -> IAsyncResult
Public Function BeginExecuteReader () As IAsyncResult

Restituisce

Oggetto IAsyncResult che può essere usato per eseguire il polling, attendere i risultati o entrambe le cose. Questo valore è necessario anche per chiamare il metodo EndExecuteReader(IAsyncResult), che restituisce un'istanza SqlDataReader utilizzabile per recuperare le righe restituite.

Eccezioni

È stato usato un valore SqlDbType diverso da Binary o VarBinary quando Value era impostato su Stream. Per altre informazioni sul flusso, vedere Supporto del flusso SqlClient.

-oppure-

Un SqlDbType oggetto diverso da Char, NChar, NVarChar, VarChar o Xml è stato usato quando Value è stato impostato su . TextReader

-oppure-

È stato usato un valore SqlDbType diverso da Xml quando Value era impostato su XmlReader.

Qualsiasi errore che si è verificato durante l'esecuzione del testo del comando.

-oppure-

Si è verificato un timeout durante un'operazione di flusso. Per altre informazioni sul flusso, vedere Supporto del flusso SqlClient.

La coppia nome/valore "Asynchronous Processing=true" non è stata inclusa nella stringa di connessione che definisce la connessione per SqlCommand.

-oppure-

L'elemento SqlConnection chiuso o eliminato durante l'operazione di flusso. Per altre informazioni sul flusso, vedere Supporto del flusso SqlClient.

Errore nell'oggetto Stream, XmlReader o TextReader durante un'operazione di flusso. Per altre informazioni sul flusso, vedere Supporto del flusso SqlClient.

L'oggetto Stream, XmlReader o TextReader è stato chiuso durante l'operazione di flusso. Per altre informazioni sul flusso, vedere Supporto del flusso SqlClient.

Esempio

L'applicazione console seguente avvia il processo di recupero di un lettore di dati in modo asincrono. In attesa dei risultati, questa semplice applicazione si trova in un ciclo, esaminando il valore della IsCompleted proprietà. Non appena il processo è stato completato, il codice recupera e visualizza il SqlDataReader relativo contenuto.

using System.Data.SqlClient;

class Class1
{
    static void Main()
    {
        // This is a simple example that demonstrates the usage of the
        // BeginExecuteReader functionality
        // The WAITFOR statement simply adds enough time to prove the
        // asynchronous nature of the command.
        string commandText =
            "WAITFOR DELAY '00:00:03';" +
            "SELECT LastName, FirstName FROM Person.Contact " +
            "WHERE LastName LIKE 'M%'";

        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
            {
                SqlCommand command = new SqlCommand(commandText, connection);

                connection.Open();
                IAsyncResult result = command.BeginExecuteReader();

                // Although it is not necessary, the following code
                // displays a counter in the console window, indicating that
                // the main thread is not blocked while awaiting the command
                // results.
                int count = 0;
                while (!result.IsCompleted)
                {
                    count += 1;
                    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);
                }

                using (SqlDataReader reader = command.EndExecuteReader(result))
                {
                    DisplayResults(reader);
                }
            }
            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 void DisplayResults(SqlDataReader reader)
    {
        // Display the data within the reader.
        while (reader.Read())
        {
            // Display all the columns.
            for (int i = 0; i < reader.FieldCount; i++)
                Console.Write("{0} ", reader.GetValue(i));
            Console.WriteLine();
        }
    }

    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";
    }
}
Imports System.Data.SqlClient

Module Module1
    Sub Main()
        ' This is a simple example that demonstrates the usage of the 
        ' BeginExecuteReader functionality.
        ' The WAITFOR statement simply adds enough time to prove the 
        ' asynchronous nature of the command.
        Dim commandText As String = _
         "WAITFOR DELAY '00:00:03';" & _
         "SELECT LastName, FirstName FROM Person.Contact " & _
         "WHERE LastName LIKE 'M%'"

        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 command As New SqlCommand(commandText, connection)

                connection.Open()
                Dim result As IAsyncResult = command.BeginExecuteReader()

                ' Although it is not necessary, the following procedure
                ' displays a counter in the console window, indicating that 
                ' the main thread is not blocked while awaiting the command 
                ' results.
                Dim count As Integer
                While Not result.IsCompleted
                    count += 1
                    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)
                End While

                ' Once the IAsyncResult object signals that it is done
                ' waiting for results, you can retrieve the results.
                Using reader As SqlDataReader = command.EndExecuteReader(result)
                    DisplayResults(reader)
                End Using
            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 Sub DisplayResults(ByVal reader As SqlDataReader)
        ' Display the data within the reader.
        While reader.Read()
            ' Display all the columns.
            For i As Integer = 0 To reader.FieldCount - 1
                Console.Write("{0} ", reader.GetValue(i))
            Next
            Console.WriteLine()
        End While
    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=true;" & _
          "Initial Catalog=AdventureWorks; Asynchronous Processing=true"
    End Function
End Module

Commenti

Il BeginExecuteReader metodo avvia il processo di esecuzione asincrona di un'istruzione Transact-SQL o di una stored procedure che 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 EndExecuteReader metodo per completare l'operazione e recuperare il SqlDataReader restituito dal comando. Il BeginExecuteReader metodo restituisce immediatamente, ma fino a quando il codice esegue la chiamata al metodo corrispondente EndExecuteReader , non deve eseguire altre chiamate che avviano un'esecuzione sincrona o asincrona sullo stesso SqlCommand oggetto. La chiamata all'oggetto EndExecuteReader 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. Anche se l'esecuzione dei comandi è asincrona, il recupero dei valori è ancora sincrono. Ciò significa che le chiamate a Read possono bloccare se sono necessari più dati e i blocchi di operazioni di lettura della rete sottostante.

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 restituitoIAsyncResultBeginExecuteReader.IAsyncResult

Se si usa ExecuteReader o BeginExecuteReader si accede ai dati XML, SQL Server restituirà i risultati XML superiori a 2.033 caratteri in lunghezza in più righe di 2.033 caratteri ciascuno. Per evitare questo comportamento, usare ExecuteXmlReader o BeginExecuteXmlReader leggere query FOR XML.

Questo metodo ignora la CommandTimeout proprietà.

Vedi anche

Si applica a

BeginExecuteReader(CommandBehavior)

Avvia l'esecuzione asincrona dell'istruzione Transact-SQL o della stored procedure descritta dall'oggetto SqlCommand usando uno dei valori CommandBehavior.

public:
 IAsyncResult ^ BeginExecuteReader(System::Data::CommandBehavior behavior);
public IAsyncResult BeginExecuteReader (System.Data.CommandBehavior behavior);
member this.BeginExecuteReader : System.Data.CommandBehavior -> IAsyncResult
Public Function BeginExecuteReader (behavior As CommandBehavior) As IAsyncResult

Parametri

behavior
CommandBehavior

Uno dei valori di CommandBehavior che indica le opzioni per l'esecuzione dell'istruzione e il recupero dei dati.

Restituisce

Oggetto IAsyncResult che può essere usato per eseguire il polling, attendere i risultati o entrambe le cose. Questo valore è necessario anche per chiamare il metodo EndExecuteReader(IAsyncResult), che restituisce un'istanza SqlDataReader utilizzabile per recuperare le righe restituite.

Eccezioni

È stato usato un valore SqlDbType diverso da Binary o VarBinary quando Value era impostato su Stream. Per altre informazioni sul flusso, vedere Supporto del flusso SqlClient.

-oppure-

Un SqlDbType oggetto diverso da Char, NChar, NVarChar, VarChar o Xml è stato usato quando Value è stato impostato su . TextReader

-oppure-

È stato usato un valore SqlDbType diverso da Xml quando Value era impostato su XmlReader.

Qualsiasi errore che si è verificato durante l'esecuzione del testo del comando.

-oppure-

Si è verificato un timeout durante un'operazione di flusso. Per altre informazioni sul flusso, vedere Supporto del flusso SqlClient.

La coppia nome/valore "Asynchronous Processing=true" non è stata inclusa nella stringa di connessione che definisce la connessione per SqlCommand.

-oppure-

L'elemento SqlConnection chiuso o eliminato durante l'operazione di flusso. Per altre informazioni sul flusso, vedere Supporto del flusso SqlClient.

Errore nell'oggetto Stream, XmlReader o TextReader durante un'operazione di flusso. Per altre informazioni sul flusso, vedere Supporto del flusso SqlClient.

L'oggetto Stream, XmlReader o TextReader è stato chiuso durante l'operazione di flusso. Per altre informazioni sul flusso, vedere Supporto del flusso SqlClient.

Esempio

L'applicazione console seguente avvia il processo di recupero di un lettore di dati in modo asincrono. In attesa dei risultati, questa semplice applicazione si trova in un ciclo, esaminando il valore della IsCompleted proprietà. Al termine del processo, il codice recupera e SqlDataReader ne visualizza il contenuto.

Questo esempio passa anche i CommandBehavior.CloseConnection valori e CommandBehavior.SingleRow nel parametro di comportamento, causando la chiusura della connessione con il restituito SqlDataReader e l'ottimizzazione per un singolo risultato di riga.

using System.Data.SqlClient;
class Class1
{
    static void Main()
    {
        // This example is not terribly useful, but it proves a point.
        // The WAITFOR statement simply adds enough time to prove the
        // asynchronous nature of the command.
        string commandText = "WAITFOR DELAY '00:00:03';" +
            "SELECT ProductID, Name FROM Production.Product WHERE ListPrice < 100";

        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.

        try
        {
            // The code does not need to handle closing the connection explicitly--
            // the use of the CommandBehavior.CloseConnection option takes care
            // of that for you.
            SqlConnection connection = new SqlConnection(connectionString);
            SqlCommand command = new SqlCommand(commandText, connection);

            connection.Open();
            IAsyncResult result = command.BeginExecuteReader(
                CommandBehavior.CloseConnection);

            // Although it is not necessary, the following code
            // displays a counter in the console window, indicating that
            // the main thread is not blocked while awaiting the command
            // results.
            int count = 0;
            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);
            }

            using (SqlDataReader reader = command.EndExecuteReader(result))
            {
                DisplayResults(reader);
            }
        }
        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 void DisplayResults(SqlDataReader reader)
    {
        // Display the data within the reader.
        while (reader.Read())
        {
            // Display all the columns.
            for (int i = 0; i < reader.FieldCount; i++)
            {
                Console.Write("{0}\t", reader.GetValue(i));
            }
            Console.WriteLine();
        }
    }

    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";
    }
}
Imports System.Data.SqlClient

Module Module1
    Sub Main()
        ' This example is not terribly useful, but it proves a point.
        ' The WAITFOR statement simply adds enough time to prove the 
        ' asynchronous nature of the command.
        Dim commandText As String = _
         "WAITFOR DELAY '00:00:03';" & _
         "SELECT ProductID, Name FROM Production.Product WHERE ListPrice < 100"

        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. 
        Try
            ' The code does not need to handle closing the connection explicitly--
            ' the use of the CommandBehavior.CloseConnection option takes care
            ' of that for you. 
            Dim connection As New SqlConnection(connectionString)
            Dim command As New SqlCommand(commandText, connection)

            connection.Open()
            Dim result As IAsyncResult = _
              command.BeginExecuteReader(CommandBehavior.CloseConnection)

            ' Although it is not necessary, the following code
            ' displays a counter in the console window, indicating that 
            ' the main thread is not blocked while awaiting the command 
            ' results.
            Dim count As Integer = 0
            While Not result.IsCompleted
                count += 1
                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)
            End While

            ' The "using" statement closes the SqlDataReader when it is 
            ' done executing.
            Using reader As SqlDataReader = command.EndExecuteReader(result)
                DisplayResults(reader)
            End Using
        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 Sub

    Private Sub DisplayResults(ByVal reader As SqlDataReader)
        ' Display the data within the reader.
        While reader.Read()
            ' Display all the columns. 
            For i As Integer = 0 To reader.FieldCount - 1
                Console.Write("{0} ", reader.GetValue(i))
            Next
            Console.WriteLine()
        End While
    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=true;" & _
          "Initial Catalog=AdventureWorks; Asynchronous Processing=true"
    End Function
End Module

Commenti

Il BeginExecuteReader metodo avvia il processo di esecuzione asincrona di un'istruzione Transact-SQL o di una stored procedure che 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 EndExecuteReader metodo per completare l'operazione e recuperare il SqlDataReader restituito dal comando. Il BeginExecuteReader metodo restituisce immediatamente, ma fino a quando il codice esegue la chiamata al metodo corrispondente EndExecuteReader , non deve eseguire altre chiamate che avviano un'esecuzione sincrona o asincrona sullo stesso SqlCommand oggetto. La chiamata all'oggetto EndExecuteReader prima del completamento dell'esecuzione del comando causa SqlCommand il blocco dell'oggetto fino al termine dell'esecuzione.

Il behavior parametro consente di specificare opzioni che controllano il comportamento del comando e la relativa connessione. Questi valori possono essere combinati (usando l'operatore del OR linguaggio di programmazione); in genere gli sviluppatori usano il CommandBehavior.CloseConnection valore per assicurarsi che la connessione venga chiusa dal runtime quando l'oggetto SqlDataReader viene chiuso.

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. Anche se l'esecuzione dei comandi è asincrona, il recupero dei valori è ancora sincrono. Ciò significa che le chiamate a Read possono bloccare se sono necessari più dati e i blocchi di operazioni di lettura della rete sottostante.

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

Se si usa ExecuteReader o BeginExecuteReader si accede ai dati XML, SQL Server restituisce i risultati XML superiori a 2.033 caratteri in lunghezza in più righe di 2.033 caratteri ciascuno. Per evitare questo comportamento, usare ExecuteXmlReader o BeginExecuteXmlReader leggere query FOR XML.

Questo metodo ignora la CommandTimeout proprietà.

Vedi anche

Si applica a

BeginExecuteReader(AsyncCallback, Object)

Avvia l'esecuzione asincrona dell'istruzione Transact-SQL o della stored procedure descritta dall'oggetto SqlCommand e recupera uno o più set di risultati dal server, in base alla routine di callback e alle informazioni sullo stato.

public:
 IAsyncResult ^ BeginExecuteReader(AsyncCallback ^ callback, System::Object ^ stateObject);
public IAsyncResult BeginExecuteReader (AsyncCallback callback, object stateObject);
member this.BeginExecuteReader : AsyncCallback * obj -> IAsyncResult
Public Function BeginExecuteReader (callback As AsyncCallback, stateObject As Object) As IAsyncResult

Parametri

callback
AsyncCallback

Delegato AsyncCallback richiamato al termine dell'esecuzione del comando. Passare null (Nothing in Microsoft Visual Basic) per indicare che non è necessario alcun callback.

stateObject
Object

Oggetto di stato definito dall'utente e passato alla routine di callback. Recuperare questo oggetto dalla routine di callback usando la proprietà AsyncState.

Restituisce

Oggetto IAsyncResult che può essere usato per eseguire il polling, attendere i risultati o entrambe le cose. Questo valore è necessario anche per chiamare il metodo EndExecuteReader(IAsyncResult), che restituisce un'istanza di SqlDataReader che può essere usata per recuperare le righe restituite.

Eccezioni

È stato usato un valore SqlDbType diverso da Binary o VarBinary quando Value era impostato su Stream. Per altre informazioni sul flusso, vedere Supporto del flusso SqlClient.

-oppure-

Un SqlDbType oggetto diverso da Char, NChar, NVarChar, VarChar o Xml è stato usato quando Value è stato impostato su . TextReader

-oppure-

È stato usato un valore SqlDbType diverso da Xml quando Value era impostato su XmlReader.

Qualsiasi errore che si è verificato durante l'esecuzione del testo del comando.

-oppure-

Si è verificato un timeout durante un'operazione di flusso. Per altre informazioni sul flusso, vedere Supporto del flusso SqlClient.

La coppia nome/valore "Asynchronous Processing=true" non è stata inclusa nella stringa di connessione che definisce la connessione per SqlCommand.

-oppure-

L'elemento SqlConnection chiuso o eliminato durante l'operazione di flusso. Per altre informazioni sul flusso, vedere Supporto del flusso SqlClient.

Errore nell'oggetto Stream, XmlReader o TextReader durante un'operazione di flusso. Per altre informazioni sul flusso, vedere Supporto del flusso SqlClient.

L'oggetto Stream, XmlReader o TextReader è stato chiuso durante l'operazione di flusso. Per altre informazioni sul flusso, vedere Supporto del flusso SqlClient.

Esempio

Nell'applicazione Windows seguente viene illustrato l'uso del metodo BeginExecuteReader, eseguendo un'istruzione Transact-SQL che include un ritardo di pochi secondi (emulando un comando con esecuzione prolungata). Poiché l'esempio esegue il comando in modo asincrono, il modulo rimane reattivo mentre attende i risultati. In questo esempio viene passato l'oggetto in esecuzione SqlCommand come stateObject parametro. In questo modo è semplice recuperare l'oggetto SqlCommand dall'interno della routine di callback, in modo che il codice possa chiamare il EndExecuteReader metodo corrispondente alla chiamata iniziale a BeginExecuteReader.

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 è necessario 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, un DataGridView controllo e un ButtonLabel controllo nel modulo (accettando il nome predefinito per ogni controllo). Aggiungere il codice seguente alla classe del modulo, modificando il stringa di connessione in base alle esigenze dell'ambiente.

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:

        // You need this delegate in order to fill the grid from
        // a thread other than the form's thread. See the HandleCallback
        // procedure for more information.
        private delegate void FillGridDelegate(SqlDataReader reader);

        // You need this delegate to update the status bar.
        private delegate void DisplayStatusDelegate(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 = false;

        // Because the overloaded version of BeginExecuteReader
        // demonstrated here does not allow you to have the connection
        // closed automatically, this example maintains the
        // connection object externally, so that it is available for closing.
        private SqlConnection connection = null;

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

        private void FillGrid(SqlDataReader reader)
        {
            try
            {
                DataTable table = new DataTable();
                table.Load(reader);
                this.dataGridView1.DataSource = table;
                DisplayStatus("Ready");
            }
            catch (Exception ex)
            {
                // Because you are guaranteed this procedure
                // is running from within the form's thread,
                // it can directly interact with members of the form.
                DisplayStatus(string.Format("Ready (last attempt failed: {0})",
                    ex.Message));
            }
            finally
            {
                // Do not forget to close the connection, as well.
                if (reader != null)
                {
                    reader.Close();
                }
                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;
                SqlDataReader reader = command.EndExecuteReader(result);
                // 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
                // fills the grid, like this:
                // FillGrid(reader);
                // 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.
                FillGridDelegate del = new FillGridDelegate(FillGrid);
                this.Invoke(del, reader);
                // Do not close the reader here, because it is being used in
                // a separate thread. Instead, have the procedure you have
                // called close the reader once it is done with it.
            }
            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 there is none of
                // your code 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 DisplayStatusDelegate(DisplayStatus),
                    "Error: " + ex.Message);
            }
            finally
            {
                isExecuting = false;
            }
        }

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

            // If you do not include the Asynchronous Processing=true name/value pair,
            // you wo not be able to execute the command asynchronously.
            return "Data Source=(local);Integrated Security=true;" +
                "Initial Catalog=AdventureWorks; Asynchronous Processing=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
                {
                    DisplayStatus("Connecting...");
                    connection = new SqlConnection(GetConnectionString());
                    // To emulate a long-running query, wait for
                    // a few seconds before retrieving the real data.
                    command = new SqlCommand("WAITFOR DELAY '0:0:5';" +
                        "SELECT ProductID, Name, ListPrice, Weight FROM Production.Product",
                        connection);
                    connection.Open();

                    DisplayStatus("Executing...");
                    isExecuting = true;
                    // Although it is not required that you pass the
                    // SqlCommand object as the second parameter in the
                    // BeginExecuteReader call, doing so makes it easier
                    // to call EndExecuteReader in the callback procedure.
                    AsyncCallback callback = new AsyncCallback(HandleCallback);
                    command.BeginExecuteReader(callback, command);
                }
                catch (Exception ex)
                {
                    DisplayStatus("Error: " + ex.Message);
                    if (connection != null)
                    {
                        connection.Close();
                    }
                }
            }
        }

        private void Form1_Load(object sender, System.EventArgs e)
        {
            this.button1.Click += new System.EventHandler(this.button1_Click);
            this.FormClosing += new FormClosingEventHandler(Form1_FormClosing);
        }

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

Public Class Form1
    ' Add this code to the form's class:
    ' You need this delegate in order to fill the grid from
    ' a thread other than the form's thread. See the HandleCallback
    ' procedure for more information.
    Private Delegate Sub FillGridDelegate(ByVal reader As SqlDataReader)

    ' You need this delegate to update the status bar.
    Private Delegate Sub DisplayStatusDelegate(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

    ' Because the overloaded version of BeginExecuteReader
    ' demonstrated here does not allow you to have the connection
    ' closed automatically, this example maintains the 
    ' connection object externally, so that it is available for closing.
    Private connection As SqlConnection

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

    Private Sub FillGrid(ByVal reader As SqlDataReader)
        Try
            Dim table As New DataTable
            table.Load(reader)
            Me.DataGridView1.DataSource = table
            DisplayStatus("Ready")

        Catch ex As Exception
            ' Because you are guaranteed this procedure
            ' is running from within the form's thread,
            ' it can directly interact with members of the form.
            DisplayStatus(String.Format("Ready (last attempt failed: {0})", ex.Message))
        Finally
            ' Do not forget to close the connection, as well.
            If Not reader Is Nothing Then
                reader.Close()
            End If
            If Not connection Is Nothing Then
                connection.Close()
            End If
        End Try
    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 reader As SqlDataReader = command.EndExecuteReader(result)

            ' 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 
            ' fills the grid, like this:
            ' FillGrid(reader)

            ' 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 FillGridDelegate(AddressOf FillGrid)
            Me.Invoke(del, reader)
            ' Do not close the reader here, because it is being used in 
            ' a separate thread. Instead, have the procedure you have
            ' called close the reader once it is done with it.

        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 there is none of 
            ' your code 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 DisplayStatusDelegate(AddressOf DisplayStatus), _
             "Error: " & ex.Message)
        Finally
            isExecuting = False
        End Try
    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 do not include the Asynchronous Processing=true name/value pair,
        ' you wo not be able to execute the command asynchronously.

        Return "Data Source=(local);Integrated Security=true;" & _
        "Initial Catalog=AdventureWorks; Asynchronous Processing=true"
    End Function

    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
                DisplayStatus("Connecting...")
                connection = New SqlConnection(GetConnectionString())
                ' To emulate a long-running query, wait for 
                ' a few seconds before retrieving the real data.
                command = New SqlCommand( _
                 "WAITFOR DELAY '0:0:5';" & _
                 "SELECT ProductID, Name, ListPrice, Weight FROM Production.Product", _
                 connection)
                connection.Open()

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

            Catch ex As Exception
                DisplayStatus("Error: " & ex.Message)
                If connection IsNot Nothing Then
                    connection.Close()
                End If
            End Try
        End If
    End Sub

    Private Sub Form1_FormClosing(ByVal sender As Object, _
        ByVal e As System.Windows.Forms.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
End Class

Commenti

Il BeginExecuteReader metodo avvia il processo di esecuzione asincrona di un'istruzione Transact-SQL o di una stored procedure che 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 EndExecuteReader metodo per completare l'operazione e recuperare il SqlDataReader restituito dal comando. Il BeginExecuteReader metodo restituisce immediatamente, ma fino a quando il codice esegue la chiamata al metodo corrispondente EndExecuteReader , non deve eseguire altre chiamate che avviano un'esecuzione sincrona o asincrona sullo stesso SqlCommand oggetto. EndExecuteReader La chiamata all'oggetto 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 EndExecuteReader metodo dall'interno di questa procedura delegata o da qualsiasi altra posizione all'interno dell'applicazione. È inoltre possibile passare qualsiasi oggetto nel stateObject 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. Anche se l'esecuzione dei comandi è asincrona, il recupero dei valori è ancora sincrono. Ciò significa che le chiamate a Read possono bloccare se sono necessari più dati e i blocchi di operazioni di lettura della rete sottostante.

Poiché la routine di callback viene eseguita dall'interno di un thread in background fornito dal runtime di Microsoft .NET, è 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.

Se si usa ExecuteReader o BeginExecuteReader si accede ai dati XML, SQL Server restituisce i risultati XML superiori a 2.033 caratteri in lunghezza in più righe di 2.033 caratteri ciascuno. Per evitare questo comportamento, usare ExecuteXmlReader o BeginExecuteXmlReader leggere query FOR XML.

Questo metodo ignora la CommandTimeout proprietà.

Vedi anche

Si applica a

BeginExecuteReader(AsyncCallback, Object, CommandBehavior)

Avvia l'esecuzione asincrona dell'istruzione o della stored procedure Transact-SQL descritta da SqlCommand, usando uno dei valori di CommandBehavior e recuperando uno o più set di risultati dal server, in base a una routine di callback e alle informazioni sullo stato.

public:
 IAsyncResult ^ BeginExecuteReader(AsyncCallback ^ callback, System::Object ^ stateObject, System::Data::CommandBehavior behavior);
public IAsyncResult BeginExecuteReader (AsyncCallback callback, object stateObject, System.Data.CommandBehavior behavior);
member this.BeginExecuteReader : AsyncCallback * obj * System.Data.CommandBehavior -> IAsyncResult
Public Function BeginExecuteReader (callback As AsyncCallback, stateObject As Object, behavior As CommandBehavior) As IAsyncResult

Parametri

callback
AsyncCallback

Delegato AsyncCallback richiamato al termine dell'esecuzione del comando. Passare null (Nothing in Microsoft Visual Basic) per indicare che non è necessario alcun callback.

stateObject
Object

Oggetto di stato definito dall'utente e passato alla routine di callback. Recuperare questo oggetto dalla routine di callback usando la proprietà AsyncState.

behavior
CommandBehavior

Uno dei valori di CommandBehavior che indica le opzioni per l'esecuzione dell'istruzione e il recupero dei dati.

Restituisce

Oggetto IAsyncResult che può essere usato per eseguire il polling o restare in attesa dei risultati, o entrambe le operazioni. Questo valore è necessario anche quando si richiama EndExecuteReader(IAsyncResult), che restituisce un'istanza di SqlDataReader che può essere usata per recuperare le righe restituite.

Eccezioni

È stato usato un valore SqlDbType diverso da Binary o VarBinary quando Value era impostato su Stream. Per altre informazioni sul flusso, vedere Supporto del flusso SqlClient.

-oppure-

Un SqlDbType oggetto diverso da Char, NChar, NVarChar, VarChar o Xml è stato usato quando Value è stato impostato su . TextReader

-oppure-

È stato usato un valore SqlDbType diverso da Xml quando Value era impostato su XmlReader.

Qualsiasi errore che si è verificato durante l'esecuzione del testo del comando.

-oppure-

Si è verificato un timeout durante un'operazione di flusso. Per altre informazioni sul flusso, vedere Supporto del flusso SqlClient.

La coppia nome/valore "Asynchronous Processing=true" non è stata inclusa nella stringa di connessione che definisce la connessione per SqlCommand.

-oppure-

L'elemento SqlConnection chiuso o eliminato durante l'operazione di flusso. Per altre informazioni sul flusso, vedere Supporto del flusso SqlClient.

Errore nell'oggetto Stream, XmlReader o TextReader durante un'operazione di flusso. Per altre informazioni sul flusso, vedere Supporto del flusso SqlClient.

L'oggetto Stream, XmlReader o TextReader è stato chiuso durante l'operazione di flusso. Per altre informazioni sul flusso, vedere Supporto del flusso SqlClient.

Esempio

Nell'applicazione Windows seguente viene illustrato l'uso del metodo BeginExecuteReader, eseguendo un'istruzione Transact-SQL che include un ritardo di pochi secondi (emulando un comando con esecuzione prolungata). Poiché l'esempio esegue il comando in modo asincrono, il modulo rimane reattivo mentre attende i risultati. In questo esempio viene passato l'oggetto in esecuzione SqlCommand come stateObject parametro. In questo modo è semplice recuperare l'oggetto SqlCommand dall'interno della routine di callback, in modo che il codice possa chiamare il EndExecuteReader metodo corrispondente alla chiamata iniziale a BeginExecuteReader.

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 è necessario 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, un DataGridView controllo e un ButtonLabel controllo nel modulo (accettando il nome predefinito per ogni controllo). Aggiungere il codice seguente alla classe del modulo, modificando il stringa di connessione in base alle esigenze dell'ambiente.

In questo esempio viene passato il CommandBehavior.CloseConnection valore nel behavior parametro, causando la chiusura automatica della connessione restituita SqlDataReader quando viene chiusa.

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:
        // You need this delegate in order to fill the grid from
        // a thread other than the form's thread. See the HandleCallback
        // procedure for more information.
        private delegate void FillGridDelegate(SqlDataReader reader);

        // You need this delegate to update the status bar.
        private delegate void DisplayStatusDelegate(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;

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

        private void FillGrid(SqlDataReader reader)
        {
            try
            {
                DataTable table = new DataTable();
                table.Load(reader);
                this.dataGridView1.DataSource = table;
                DisplayStatus("Ready");
            }
            catch (Exception ex)
            {
                // Because you are guaranteed this procedure
                // is running from within the form's thread,
                // it can directly interact with members of the form.
                DisplayStatus(string.Format("Ready (last attempt failed: {0})",
                    ex.Message));
            }
            finally
            {
                // Closing the reader also closes the connection,
                // because this reader was created using the
                // CommandBehavior.CloseConnection value.
                if (reader != null)
                {
                    reader.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;
                SqlDataReader reader = command.EndExecuteReader(result);
                // 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
                // fills the grid, like this:
                // FillGrid(reader);
                // 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.
                FillGridDelegate del = new FillGridDelegate(FillGrid);
                this.Invoke(del, reader);
                // Do not close the reader here, because it is being used in
                // a separate thread. Instead, have the procedure you have
                // called close the reader once it is done with it.
            }
            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 there is none of
                // your code 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 DisplayStatusDelegate(DisplayStatus), "Error: " +
                    ex.Message);
            }
            finally
            {
                isExecuting = false;
            }
        }

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

            // If you do not include the Asynchronous Processing=true name/value pair,
            // you wo not be able to execute the command asynchronously.
            return "Data Source=(local);Integrated Security=true;" +
                "Initial Catalog=AdventureWorks; Asynchronous Processing=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;
                SqlConnection connection = null;
                try
                {
                    DisplayStatus("Connecting...");
                    connection = new SqlConnection(GetConnectionString());
                    // To emulate a long-running query, wait for
                    // a few seconds before retrieving the real data.
                    command = new SqlCommand("WAITFOR DELAY '0:0:5';" +
                        "SELECT ProductID, Name, ListPrice, Weight FROM Production.Product",
                        connection);
                    connection.Open();

                    DisplayStatus("Executing...");
                    isExecuting = true;
                    // Although it is not required that you pass the
                    // SqlCommand object as the second parameter in the
                    // BeginExecuteReader call, doing so makes it easier
                    // to call EndExecuteReader in the callback procedure.
                    AsyncCallback callback = new AsyncCallback(HandleCallback);
                    command.BeginExecuteReader(callback, command,
                        CommandBehavior.CloseConnection);
                }
                catch (Exception ex)
                {
                    DisplayStatus("Error: " + ex.Message);
                    if (connection != null)
                    {
                        connection.Close();
                    }
                }
            }
        }

        private void Form1_Load(object sender, System.EventArgs e)
        {
            this.button1.Click += new System.EventHandler(this.button1_Click);
            this.FormClosing += new FormClosingEventHandler(Form1_FormClosing);
        }

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

Public Class Form1
    ' Add this code to the form's class:
    ' You this delegate in order to fill the grid from
    ' a thread other than the form's thread. See the HandleCallback
    ' procedure for more information.
    Private Delegate Sub FillGridDelegate(ByVal reader As SqlDataReader)

    ' You need this delegate to update the status bar.
    Private Delegate Sub DisplayStatusDelegate(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

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

    Private Sub FillGrid(ByVal reader As SqlDataReader)
        Try
            Dim table As New DataTable
            table.Load(reader)
            Me.DataGridView1.DataSource = table
            DisplayStatus("Ready")

        Catch ex As Exception
            ' Because you are guaranteed this procedure
            ' is running from within the form's thread,
            ' it can directly interact with members of the form.
            DisplayStatus(String.Format("Ready (last attempt failed: {0})", ex.Message))
        Finally
            ' Closing the reader also closes the connection,
            ' because this reader was created using the 
            ' CommandBehavior.CloseConnection value.
            If reader IsNot Nothing Then
                reader.Close()
            End If
        End Try
    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 reader As SqlDataReader = command.EndExecuteReader(result)

            ' 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 
            ' fills the grid, like this:
            ' FillGrid(reader)

            ' 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 FillGridDelegate(AddressOf FillGrid)
            Me.Invoke(del, reader)

            ' Do not close the reader here, because it is being used in 
            ' a separate thread. Instead, have the procedure you have
            ' called close the reader once it is done with it.

        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 there is none of 
            ' your code 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 DisplayStatusDelegate(AddressOf DisplayStatus), _
             "Error: " & ex.Message)
        Finally
            isExecuting = False
        End Try
    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 do not include the Asynchronous Processing=true name/value pair,
        ' you wo not be able to execute the command asynchronously.

        Return "Data Source=(local);Integrated Security=true;" & _
        "Initial Catalog=AdventureWorks; Asynchronous Processing=true"
    End Function

    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 connection As SqlConnection
            Dim command As SqlCommand
            Try
                DisplayStatus("Connecting...")
                connection = New SqlConnection(GetConnectionString())
                ' To emulate a long-running query, wait for 
                ' a few seconds before retrieving the real data.
                command = New SqlCommand( _
                 "WAITFOR DELAY '0:0:5';" & _
                 "SELECT ProductID, Name, ListPrice, Weight FROM Production.Product", _
                 connection)
                connection.Open()

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

            Catch ex As Exception
                DisplayStatus("Error: " & ex.Message)
                If connection IsNot Nothing Then
                    connection.Close()
                End If
            End Try
        End If
    End Sub

    Private Sub Form1_FormClosing(ByVal sender As Object, _
        ByVal e As System.Windows.Forms.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
End Class

Commenti

Il BeginExecuteReader metodo avvia il processo di esecuzione asincrona di un'istruzione Transact-SQL o di una stored procedure che 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 EndExecuteReader metodo per completare l'operazione e recuperare il SqlDataReader restituito dal comando. Il BeginExecuteReader metodo restituisce immediatamente, ma fino a quando il codice esegue la chiamata al metodo corrispondente EndExecuteReader , non deve eseguire altre chiamate che avviano un'esecuzione sincrona o asincrona sullo stesso SqlCommand oggetto. La chiamata all'oggetto EndExecuteReader 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 EndExecuteReader metodo dall'interno di questa procedura delegata o da qualsiasi altra posizione all'interno dell'applicazione. È inoltre possibile passare qualsiasi oggetto nel stateObject parametro e la procedura di callback può recuperare queste informazioni usando la AsyncState proprietà .

Il behavior parametro consente di specificare opzioni che controllano il comportamento del comando e la relativa connessione. Questi valori possono essere combinati (usando l'operatore del Or linguaggio di programmazione); in genere gli sviluppatori usano il CloseConnection valore per assicurarsi che la connessione venga chiusa dal runtime quando l'oggetto SqlDataReader viene chiuso. Gli sviluppatori possono anche ottimizzare il comportamento dell'oggetto specificando il SingleRow valore quando è noto in anticipo che l'istruzione SqlDataReader Transact-SQL o la stored procedure restituisce solo una singola riga.

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. Anche se l'esecuzione dei comandi è asincrona, il recupero dei valori è ancora sincrono. Ciò significa che le chiamate a Read possono bloccare se sono necessari più dati e i blocchi di operazioni di lettura della rete sottostante.

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 routine di callback, è necessario aggiornare il modulo, è necessario tornare al thread del modulo per eseguire il lavoro. Nell'esempio di questo argomento viene illustrato questo comportamento.

Tutti gli errori che si verificano durante l'esecuzione dell'operazione vengono generati come eccezioni nella routine 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.

Se si utilizza ExecuteReader o BeginExecuteReader per accedere ai dati XML, SQL Server restituirà tutti i risultati XML superiori a 2.033 caratteri di lunghezza in più righe di 2.033 caratteri ciascuno. Per evitare questo comportamento, utilizzare ExecuteXmlReader o BeginExecuteXmlReader per leggere le query FOR XML.

Questo metodo ignora la CommandTimeout proprietà .

Vedi anche

Si applica a