SqlCommand.BeginExecuteReader Método

public:
 IAsyncResult ^ BeginExecuteReader();

public IAsyncResult BeginExecuteReader();

member this.BeginExecuteReader : unit -> IAsyncResult

Public Function BeginExecuteReader () As IAsyncResult

Devoluções

An IAsyncResult que pode ser usado para inquirir ou esperar por resultados, ou ambos; este valor também é necessário ao invocar EndExecuteReader(IAsyncResult), que devolve uma SqlDataReader instância que pode ser usada para recuperar as linhas devolvidas.

Exceções

Exemplos

A aplicação de consola seguinte inicia o processo de recuperação de um leitor de dados de forma assíncrona. Enquanto aguardam os resultados, esta aplicação simples fica num ciclo, a investigar o valor da IsCompleted propriedade. Assim que o processo termina, o código recupera o SqlDataReader e apresenta o seu conteúdo.

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

Observações

O método BeginExecuteReader inicia o processo de execução assíncrona de uma instrução Transact-SQL ou procedimento armazenado que devolve linhas, para que outras tarefas possam correr simultaneamente enquanto a instrução está em execução. Quando a instrução está concluída, os programadores devem chamar o EndExecuteReader método para concluir a operação e recuperar o SqlDataReader retorno pelo comando. O BeginExecuteReader método retorna imediatamente, mas até que o código execute a chamada correspondente EndExecuteReader , não deve executar quaisquer outras chamadas que iniciem uma execução síncrona ou assíncrona contra o mesmo SqlCommand objeto. Chamar o EndExecuteReader antes da execução do comando ser concluída faz com que o SqlCommand objeto bloqueie até a execução terminar.

Note que o texto do comando e os parâmetros são enviados para o servidor de forma síncrona. Se forem enviados um comando grande ou muitos parâmetros, este método pode bloquear durante as escritas. Após o envio do comando, o método retorna imediatamente sem esperar resposta do servidor — ou seja, as leituras são assíncronas. Embora a execução de comandos seja assíncrona, a busca de valores continua a ser síncrona. Isto significa que as chamadas para Read podem bloquear se forem necessários mais dados e a operação de leitura da rede subjacente bloqueada.

Como esta sobrecarga não suporta um procedimento de callback, os programadores têm de consultar para determinar se o comando foi concluído, usando a IsCompleted propriedade do IAsyncResult devolvido pelo BeginExecuteReader método; ou esperar pela conclusão de um ou mais comandos usando a AsyncWaitHandle propriedade do retorno IAsyncResult.

Se usar ExecuteReader ou BeginExecuteReader para aceder a dados XML, SQL Server devolverá quaisquer resultados XML com mais de 2.033 caracteres em várias linhas de 2.033 caracteres cada. Para evitar este comportamento, use ExecuteXmlReader ou BeginExecuteXmlReader leia consultas XML FOR.

Este método ignora a CommandTimeout propriedade.

Ver também

• Ligar e Recuperar Dados em ADO.NET
• Usando o Data Provider do .NET Framework para SQL Server
• Visão geral ADO.NET

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

Parâmetros

Devoluções

An IAsyncResult que pode ser usado para inquirir, esperar resultados, ou ambos; este valor também é necessário ao invocar EndExecuteReader(IAsyncResult), que devolve uma SqlDataReader instância que pode ser usada para recuperar as linhas devolvidas.

Exceções

Exemplos

A aplicação de consola seguinte inicia o processo de recuperação de um leitor de dados de forma assíncrona. Enquanto aguardam os resultados, esta aplicação simples fica num ciclo, a investigar o valor da IsCompleted propriedade. Uma vez concluído o processo, o código recupera o SqlDataReader e apresenta o seu conteúdo.

Este exemplo também passa os CommandBehavior.CloseConnection valores e CommandBehavior.SingleRow no parâmetro de comportamento, fazendo com que a ligação fique fechada com o retorno SqlDataReader está fechado, e para otimizar para um resultado de uma única linha.

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

Observações

O método BeginExecuteReader inicia o processo de execução assíncrona de uma instrução Transact-SQL ou procedimento armazenado que devolve linhas, para que outras tarefas possam correr simultaneamente enquanto a instrução está em execução. Quando a instrução está concluída, os programadores devem chamar o EndExecuteReader método para concluir a operação e recuperar o SqlDataReader retorno pelo comando. O BeginExecuteReader método retorna imediatamente, mas até que o código execute a chamada correspondente EndExecuteReader , não deve executar quaisquer outras chamadas que iniciem uma execução síncrona ou assíncrona contra o mesmo SqlCommand objeto. Chamar o EndExecuteReader antes da execução do comando ser concluída faz com que o SqlCommand objeto bloqueie até a execução terminar.

O behavior parâmetro permite-te especificar opções que controlam o comportamento do comando e da sua ligação. Estes valores podem ser combinados (usando o operador da OR linguagem de programação); geralmente, os programadores usam o CommandBehavior.CloseConnection valor para garantir que a ligação está fechada no tempo de execução quando o SqlDataReader está fechado.

Note que o texto do comando e os parâmetros são enviados para o servidor de forma síncrona. Se forem enviados um comando grande ou muitos parâmetros, este método pode bloquear durante as escritas. Após o envio do comando, o método retorna imediatamente sem esperar resposta do servidor — ou seja, as leituras são assíncronas. Embora a execução de comandos seja assíncrona, a busca de valores continua a ser síncrona. Isto significa que as chamadas para Read podem bloquear se forem necessários mais dados e a operação de leitura da rede subjacente bloqueada.

Como esta sobrecarga não suporta um procedimento de callback, os programadores têm de consultar para determinar se o comando foi concluído, usando a IsCompleted propriedade do IAsyncResult devolvido pelo BeginExecuteNonQuery método; ou esperar pela conclusão de um ou mais comandos usando a AsyncWaitHandle propriedade do retorno IAsyncResult.

Se usar ExecuteReader ou BeginExecuteReader para aceder a dados XML, SQL Server devolve quaisquer resultados XML com mais de 2.033 caracteres em várias linhas de 2.033 caracteres cada. Para evitar este comportamento, use ExecuteXmlReader ou BeginExecuteXmlReader leia consultas XML FOR.

Este método ignora a CommandTimeout propriedade.

Ver também

• Ligar e Recuperar Dados em ADO.NET
• Usando o Data Provider do .NET Framework para SQL Server
• Visão geral ADO.NET

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

Parâmetros

Devoluções

An IAsyncResult que pode ser usado para inquirir, esperar resultados, ou ambos; este valor também é necessário ao invocar EndExecuteReader(IAsyncResult), que devolve uma SqlDataReader instância que pode ser usada para recuperar as linhas devolvidas.

Exceções

Exemplos

O seguinte aplicativo do Windows demonstra o uso do BeginExecuteReader método, executando uma instrução Transact-SQL que inclui um atraso de alguns segundos (emulando um comando de longa execução). Como a amostra executa o comando de forma assíncrona, o formulário permanece responsivo enquanto aguarda os resultados. Este exemplo passa o objeto em SqlCommand execução como parâmetro stateObject ; ao fazê-lo, é simples recuperar o SqlCommand objeto dentro do procedimento de callback, de modo que o código pode chamar o EndExecuteReader método correspondente à chamada inicial para BeginExecuteReader.

Este exemplo demonstra muitas técnicas importantes. Isto inclui chamar um método que interage com o formulário a partir de um thread separado. Além disso, este exemplo demonstra como deve bloquear os utilizadores para que não executem um comando várias vezes em simultâneo, e como deve garantir que o formulário não fecha antes de ser chamado o procedimento de callback.

Para configurar este exemplo, crie uma nova aplicação para Windows. Coloque um Button controlo, um DataGridView controlo e um Label controlo no formulário (aceitando o nome padrão para cada controlo). Adicione o seguinte código à classe do formulário, modificando a cadeia de ligação conforme necessário para o seu 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

Observações

O método BeginExecuteReader inicia o processo de execução assíncrona de uma instrução Transact-SQL ou procedimento armazenado que devolve linhas, para que outras tarefas possam correr simultaneamente enquanto a instrução está em execução. Quando a instrução está concluída, os programadores devem chamar o EndExecuteReader método para concluir a operação e recuperar o SqlDataReader retorno pelo comando. O BeginExecuteReader método retorna imediatamente, mas até que o código execute a chamada correspondente EndExecuteReader , não deve executar quaisquer outras chamadas que iniciem uma execução síncrona ou assíncrona contra o mesmo SqlCommand objeto. Chamar o EndExecuteReader antes da execução do comando ser concluída faz com que o SqlCommand objeto bloqueie até a execução terminar.

O callback parâmetro permite especificar um AsyncCallback delegado que é chamado quando a instrução está concluída. Pode chamar o EndExecuteReader método dentro deste procedimento de delegado, ou de qualquer outro local da sua candidatura. Além disso, pode passar qualquer objeto no stateObject parâmetro, e o seu procedimento de callback pode recuperar esta informação usando a AsyncState propriedade.

Note que o texto do comando e os parâmetros são enviados para o servidor de forma síncrona. Se forem enviados um comando grande ou muitos parâmetros, este método pode bloquear durante as escritas. Após o envio do comando, o método retorna imediatamente sem esperar resposta do servidor — ou seja, as leituras são assíncronas. Embora a execução de comandos seja assíncrona, a busca de valores continua a ser síncrona. Isto significa que as chamadas para Read podem bloquear se forem necessários mais dados e a operação de leitura da rede subjacente bloqueada.

Como o procedimento de callback é executado a partir de um thread em segundo plano fornecido pelo tempo de execução Microsoft .NET, é muito importante que adote uma abordagem rigorosa ao tratamento das interações entre threads dentro das suas aplicações. Por exemplo, não deve interagir com o conteúdo de um formulário a partir do seu procedimento de callback; Se tiver de atualizar o formulário, deve voltar ao tópico do formulário para poder fazer o seu trabalho. O exemplo neste tópico demonstra este comportamento.

Todos os erros que ocorrem durante a execução da operação são lançados como exceções no procedimento de callback. Deve tratar da exceção no procedimento de callback, não na aplicação principal. Consulte o exemplo neste tópico para informações adicionais sobre como lidar com exceções no procedimento de callback.

Se usar ExecuteReader ou BeginExecuteReader para aceder a dados XML, SQL Server devolve quaisquer resultados XML com mais de 2.033 caracteres em várias linhas de 2.033 caracteres cada. Para evitar este comportamento, use ExecuteXmlReader ou BeginExecuteXmlReader leia consultas XML FOR.

Este método ignora a CommandTimeout propriedade.

Ver também

• Ligar e Recuperar Dados em ADO.NET
• Usando o Data Provider do .NET Framework para SQL Server
• Visão geral ADO.NET

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

Parâmetros

Devoluções

An IAsyncResult que pode ser usado para inquirir ou esperar por resultados, ou ambos; este valor também é necessário ao invocar EndExecuteReader(IAsyncResult), que devolve uma SqlDataReader instância que pode ser usada para recuperar as linhas devolvidas.

Exceções

Exemplos

O seguinte aplicativo do Windows demonstra o uso do BeginExecuteReader método, executando uma instrução Transact-SQL que inclui um atraso de alguns segundos (emulando um comando de longa execução). Como a amostra executa o comando de forma assíncrona, o formulário permanece responsivo enquanto aguarda os resultados. Este exemplo passa o objeto em SqlCommand execução como parâmetro stateObject ; ao fazê-lo, é simples recuperar o SqlCommand objeto dentro do procedimento de callback, de modo que o código pode chamar o EndExecuteReader método correspondente à chamada inicial para BeginExecuteReader.

Este exemplo demonstra muitas técnicas importantes. Isto inclui chamar um método que interage com o formulário a partir de um thread separado. Além disso, este exemplo demonstra como deve bloquear os utilizadores para que não executem um comando várias vezes em simultâneo, e como deve garantir que o formulário não fecha antes de ser chamado o procedimento de callback.

Para configurar este exemplo, crie uma nova aplicação para Windows. Coloque um Button controlo, um DataGridView controlo e um Label controlo no formulário (aceitando o nome padrão para cada controlo). Adicione o seguinte código à classe do formulário, modificando a cadeia de ligação conforme necessário para o seu ambiente.

Este exemplo passa o CommandBehavior.CloseConnection valor no behavior parâmetro, fazendo com que o retornado SqlDataReader feche automaticamente a sua ligação quando este está fechado.

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

Observações

O método BeginExecuteReader inicia o processo de execução assíncrona de uma instrução Transact-SQL ou procedimento armazenado que devolve linhas, para que outras tarefas possam correr simultaneamente enquanto a instrução está em execução. Quando a instrução está concluída, os programadores devem chamar o EndExecuteReader método para concluir a operação e recuperar o SqlDataReader retorno pelo comando. O BeginExecuteReader método retorna imediatamente, mas até que o código execute a chamada correspondente EndExecuteReader , não deve executar quaisquer outras chamadas que iniciem uma execução síncrona ou assíncrona contra o mesmo SqlCommand objeto. Chamar o EndExecuteReader antes da execução do comando ser concluída faz com que o SqlCommand objeto bloqueie até a execução terminar.

O callback parâmetro permite especificar um AsyncCallback delegado que é chamado quando a instrução está concluída. Pode chamar o EndExecuteReader método dentro deste procedimento de delegado, ou de qualquer outro local da sua candidatura. Além disso, pode passar qualquer objeto no stateObject parâmetro, e o seu procedimento de callback pode recuperar esta informação usando a AsyncState propriedade.

O behavior parâmetro permite-te especificar opções que controlam o comportamento do comando e da sua ligação. Estes valores podem ser combinados (usando o operador da Or linguagem de programação); geralmente, os programadores usam o CloseConnection valor para garantir que a ligação está fechada no tempo de execução quando o SqlDataReader está fechado. Os programadores também podem otimizar o comportamento do SqlDataReader especificando o valor SingleRow quando se sabe antecipadamente que a instrução Transact-SQL ou o procedimento armazenado só devolve uma única linha.

Note que o texto do comando e os parâmetros são enviados para o servidor de forma síncrona. Se forem enviados um comando grande ou muitos parâmetros, este método pode bloquear durante as escritas. Após o envio do comando, o método retorna imediatamente sem esperar resposta do servidor — ou seja, as leituras são assíncronas. Embora a execução de comandos seja assíncrona, a busca de valores continua a ser síncrona. Isto significa que as chamadas para Read podem bloquear se forem necessários mais dados e a operação de leitura da rede subjacente bloqueada.

Como o procedimento de callback é executado dentro de um thread em segundo plano fornecido pelo runtime Microsoft .NET common language, é muito importante que adote uma abordagem rigorosa para lidar com interações entre threads dentro das suas aplicações. Por exemplo, não deve interagir com o conteúdo de um formulário a partir do seu procedimento de callback — se tiver de atualizar o formulário, deve voltar ao tópico do formulário para poder fazer o seu trabalho. O exemplo neste tópico demonstra este comportamento.

Todos os erros que ocorrem durante a execução da operação são lançados como exceções no procedimento de callback. Deve tratar da exceção no procedimento de callback, não na aplicação principal. Consulte o exemplo neste tópico para informações adicionais sobre como lidar com exceções no procedimento de callback.

Se usar ExecuteReader ou BeginExecuteReader para aceder a dados XML, SQL Server devolverá quaisquer resultados XML com mais de 2.033 caracteres em várias linhas de 2.033 caracteres cada. Para evitar este comportamento, use ExecuteXmlReader ou BeginExecuteXmlReader leia consultas XML FOR.

Este método ignora a CommandTimeout propriedade.

Ver também

• Ligar e Recuperar Dados em ADO.NET
• Usando o Data Provider do .NET Framework para SQL Server
• Visão geral ADO.NET