SqlCommand.BeginExecuteReader Метод

Определение

Пространство имен:: Microsoft.Data.SqlClient

Сборка:: Microsoft.Data.SqlClient.dll

Пакет:: Microsoft.Data.SqlClient v1.0.19269.1

Пакет:: Microsoft.Data.SqlClient v1.1.4

Пакет:: Microsoft.Data.SqlClient v2.0.1

Пакет:: Microsoft.Data.SqlClient v2.1.4

Пакет:: Microsoft.Data.SqlClient v3.0.1

Пакет:: Microsoft.Data.SqlClient v3.1.0

Пакет:: Microsoft.Data.SqlClient v4.0.1

Пакет:: Microsoft.Data.SqlClient v4.1.0

Пакет:: Microsoft.Data.SqlClient v5.0.0

Пакет:: Microsoft.Data.SqlClient v5.1.0

Пакет:: Microsoft.Data.SqlClient v5.2.0

Пакет:: Microsoft.Data.SqlClient v6.0.2

Пакет:: Microsoft.Data.SqlClient v6.1.3

Пакет:: Microsoft.Data.SqlClient v7.0.1

Важно!

Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.

Перегрузки

Имя	Описание
BeginExecuteReader()	Инициирует асинхронное выполнение инструкции Transact-SQL или хранимой процедуры, описанной в этой SqlCommandстатье, и извлекает один или несколько результирующих наборов с сервера.
BeginExecuteReader(CommandBehavior)	Инициирует асинхронное выполнение инструкции Transact-SQL или хранимой процедуры, описываемой с SqlCommand помощью одного из значений CommandBehavior .
BeginExecuteReader(AsyncCallback, Object)	Инициирует асинхронное выполнение инструкции Transact-SQL или хранимой процедуры, описываемой этим SqlCommand , и возвращает результаты в качестве XmlReader объекта с помощью процедуры обратного вызова.
BeginExecuteReader(AsyncCallback, Object, CommandBehavior)	Инициирует асинхронное выполнение инструкции Transact-SQL или хранимой процедуры, описываемой этим SqlCommand, с помощью одного из них `CommandBehavior` значения и получение одного или нескольких результирующих наборов с сервера с учетом процедуры обратного вызова и сведений о состоянии.

BeginExecuteReader()

Исходный код:: SqlCommand.cs

Исходный код:: SqlCommand.cs

Исходный код:: SqlCommand.cs

Исходный код:: SqlCommand.cs

Инициирует асинхронное выполнение инструкции Transact-SQL или хранимой процедуры, описанной в этой SqlCommandстатье, и извлекает один или несколько результирующих наборов с сервера.

public:
 IAsyncResult ^ BeginExecuteReader();

public IAsyncResult BeginExecuteReader();

member this.BeginExecuteReader : unit -> IAsyncResult

Public Function BeginExecuteReader () As IAsyncResult

Возвращаемое значение

IAsyncResult

Можно IAsyncResult использовать для опроса или ожидания результатов. Это значение также необходимо при вызове EndExecuteReader(IAsyncResult), которое возвращает SqlDataReader экземпляр, который можно использовать для получения возвращаемых строк.

Исключения

InvalidCastException

Значение SqlDbType , отличное Binary от или VarBinary используемое, если Value задано значение Stream. Дополнительные сведения о потоковой передаче см. в разделе "Поддержка потоковой передачи SqlClient".
ЗначениеSqlDbType, отличное от Char, NChar, NVarCharVarCharили Xml использовалось при Value установкеTextReader.
Значение SqlDbType , отличное от Xml используемого при Value установке XmlReader.

SqlException

Любая ошибка, которая произошла при выполнении текста команды.
Время ожидания произошло во время операции потоковой передачи. Дополнительные сведения о потоковой передаче см. в разделе "Поддержка потоковой передачи SqlClient".

InvalidOperationException

Закрытый SqlConnection или удаленный во время операции потоковой передачи. Дополнительные сведения о потоковой передаче см. в разделе "Поддержка потоковой передачи SqlClient".
EnableOptimizedParameterBinding имеет значение true, а параметр с направлением Output или InputOutput добавлен в коллекцию Parameters .

IOException

Ошибка произошла в объекте Stream XmlReader или TextReader объекте во время операции потоковой передачи. Дополнительные сведения о потоковой передаче см. в разделе "Поддержка потоковой передачи SqlClient".

ObjectDisposedException

Stream Объект XmlReaderили TextReader объект был закрыт во время операции потоковой передачи. Дополнительные сведения о потоковой передаче см. в разделе "Поддержка потоковой передачи SqlClient".

Примеры

Следующее консольное приложение запускает процесс асинхронного извлечения средства чтения данных. Ожидая результатов, это простое приложение находится в цикле, исследуя IsCompleted значение свойства. После завершения процесса код извлекает SqlDataReader и отображает его содержимое.

using System;
using Microsoft.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}\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.

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

Метод BeginExecuteReader() запускает процесс асинхронного выполнения инструкции Transact-SQL или хранимой процедуры, возвращающей строки, чтобы другие задачи могли выполняться одновременно при выполнении инструкции. После завершения инструкции разработчики должны вызвать EndExecuteReader(IAsyncResult) метод, чтобы завершить операцию и получить SqlDataReader возвращенную командой команду. Метод BeginExecuteReader() возвращается немедленно, но пока код не выполнит соответствующий EndExecuteReader(IAsyncResult) вызов метода, он не должен выполнять другие вызовы, запускающие синхронное или асинхронное выполнение для того же SqlCommand объекта. EndExecuteReader(IAsyncResult) Вызов вызова перед завершением выполнения команды приводит SqlCommand к блокировке объекта до завершения выполнения.

Обратите внимание, что текст команды и параметры отправляются серверу синхронно. Если отправляется большая команда или множество параметров, этот метод может блокироваться во время записи. После отправки команды метод возвращается немедленно, не ожидая ответа от сервера, то есть операции чтения асинхронны. Хотя выполнение команды является асинхронным, получение значений по-прежнему синхронно. Это означает, что вызовы Read() могут блокироваться, если требуются дополнительные данные и блоки операций чтения базовой сети.

Так как эта перегрузка не поддерживает процедуру обратного вызова, разработчики должны либо провести опрос, чтобы определить, выполнена ли команда, используя IsCompleted свойство IAsyncResult BeginExecuteReader() возвращаемого методом; или дождитесь завершения одной или нескольких команд с помощью AsyncWaitHandle свойства возвращаемого IAsyncResult.

Если вы используете ExecuteReader() или BeginExecuteReader() используете XML-данные, SQL Server вернет все результаты XML, превышающие 2033 символов длиной в нескольких строках из 2033 символов. Чтобы избежать этого поведения, используйте ExecuteXmlReader() или BeginExecuteXmlReader() считывает запросы FOR XML.

Этот метод игнорирует CommandTimeout свойство.

Применяется к

BeginExecuteReader(CommandBehavior)

Исходный код:: SqlCommand.cs

Исходный код:: SqlCommand.cs

Исходный код:: SqlCommand.cs

Исходный код:: SqlCommand.cs

Инициирует асинхронное выполнение инструкции Transact-SQL или хранимой процедуры, описываемой с SqlCommand помощью одного из значений 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

Параметры

behavior: CommandBehavior

Одно из CommandBehavior значений, указывающее параметры выполнения инструкций и извлечения данных.

Возвращаемое значение

IAsyncResult

Можно IAsyncResult использовать для опроса, ожидания результатов или обоих результатов. Это значение также необходимо при вызове EndExecuteReader(IAsyncResult), которое возвращает SqlDataReader экземпляр, который можно использовать для получения возвращаемых строк.

Исключения

InvalidCastException

Значение SqlDbType , отличное Binary от или VarBinary используемое, если Value задано значение Stream. Дополнительные сведения о потоковой передаче см. в разделе "Поддержка потоковой передачи SqlClient".
ЗначениеSqlDbType, отличное от Char, NChar, NVarCharVarCharили Xml использовалось при Value установкеTextReader.
Значение SqlDbType , отличное от Xml используемого при Value установке XmlReader.

SqlException

Любая ошибка, которая произошла при выполнении текста команды.
Время ожидания произошло во время операции потоковой передачи. Дополнительные сведения о потоковой передаче см. в разделе "Поддержка потоковой передачи SqlClient".

InvalidOperationException

Закрытый SqlConnection или удаленный во время операции потоковой передачи. Дополнительные сведения о потоковой передаче см. в разделе "Поддержка потоковой передачи SqlClient".
EnableOptimizedParameterBinding имеет значение true, а параметр с направлением Output или InputOutput добавлен в коллекцию Parameters .

IOException

ObjectDisposedException

Примеры

В этом примере также передаются CloseConnection значения SingleRow в параметре поведения, что приводит к закрытию соединения с возвращаемым SqlDataReader результатом и оптимизации для одного результата строки.

using System;
using System.Data;
using Microsoft.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.
        return "Data Source=(local);Integrated Security=true;" +
               "Initial Catalog=AdventureWorks";
    }
}

Параметр behavior позволяет указать параметры, управляющие поведением команды и его подключением. Эти значения можно объединить (с помощью оператора языка OR программирования). Как правило, разработчики используют CommandBehavior.CloseConnection значение, чтобы убедиться, что соединение закрыто средой выполнения при закрытии SqlDataReader .

Так как эта перегрузка не поддерживает процедуру обратного вызова, разработчики должны либо провести опрос, чтобы определить, выполнена ли команда, используя IsCompleted свойство IAsyncResult BeginExecuteNonQuery() возвращаемого методом; или дождитесь завершения одной или нескольких команд с помощью AsyncWaitHandle свойства возвращаемого IAsyncResult.

При использовании ExecuteReader() или BeginExecuteReader() доступе к XML-данным SQL Server возвращает все результаты XML, превышающие 2033 символов длиной в нескольких строках из 2033 символов. Чтобы избежать этого поведения, используйте ExecuteXmlReader() или BeginExecuteXmlReader() считывает запросы FOR XML.

Этот метод игнорирует CommandTimeout свойство.

Применяется к

BeginExecuteReader(AsyncCallback, Object)

Исходный код:: SqlCommand.cs

Исходный код:: SqlCommand.cs

Исходный код:: SqlCommand.cs

Исходный код:: SqlCommand.cs

Инициирует асинхронное выполнение инструкции Transact-SQL или хранимой процедуры, описываемой этим SqlCommand , и возвращает результаты в качестве XmlReader объекта с помощью процедуры обратного вызова.

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

Параметры

callback: AsyncCallback

Делегат AsyncCallback , который вызывается при завершении выполнения команды. Пройти null ( Nothing в Microsoft Visual Basic) указывает, что обратный вызов не требуется.

stateObject: Object

Определяемый пользователем объект состояния, передаваемый процедуре обратного вызова. Извлеките этот объект из процедуры обратного вызова с помощью AsyncState свойства.

Возвращаемое значение

IAsyncResult

Можно IAsyncResult использовать для опроса, ожидания результатов или обоих. Это значение также необходимо при EndExecuteXmlReader(IAsyncResult) вызове, которое возвращает результаты команды в виде XML.

Исключения

InvalidCastException

Если задано значение Stream"Двоичный" или "VarBinary", используется Value значение "ДвоичныйSqlDbType" или "VarBinary". Дополнительные сведения о потоковой передаче см. в разделе "Поддержка потоковой передачи SqlClient".

–или–

Если SqlDbType задано Value TextReader значение "Char", "NChar", "NVarChar", "VarChar" или "Xml"

–или–

Значение SqlDbType , отличное от xml , использовалось при Value установке XmlReader .

SqlException

Любая ошибка, которая произошла при выполнении текста команды.

–или–

Время ожидания произошло во время операции потоковой передачи. Дополнительные сведения о потоковой передаче см. в разделе "Поддержка потоковой передачи SqlClient".

InvalidOperationException

Закрытый SqlConnection или удаленный во время операции потоковой передачи. Дополнительные сведения о потоковой передаче см. в разделе "Поддержка потоковой передачи SqlClient".

- or -

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

IOException

ObjectDisposedException

XmlReader Объект Stream или TextReader объект был закрыт во время операции потоковой передачи. Дополнительные сведения о потоковой передаче см. в разделе "Поддержка потоковой передачи SqlClient".

Примеры

Следующее приложение Windows демонстрирует использование метода BeginExecuteXmlReader, выполняющего инструкцию Transact-SQL, которая включает в себя задержку в несколько секунд (эмуляция длительной команды). Этот пример передает исполняемый SqlCommand объект в качестве stateObject параметра, что упрощает извлечение SqlCommand объекта из процедуры обратного вызова, чтобы код смог вызвать EndExecuteXmlReader метод, соответствующий первоначальному вызову BeginExecuteXmlReader.

В этом примере демонстрируется множество важных методов. Это включает вызов метода, взаимодействующего с формой из отдельного потока. Кроме того, в этом примере показано, как необходимо запретить пользователям выполнять команду несколько раз одновременно и как необходимо убедиться, что форма не закрывается перед вызовом процедуры обратного вызова.

Чтобы настроить этот пример, создайте новое приложение Windows. Button Поместите элемент управления, ListBox элемент управления и Label элемент управления в форму (принимая имя по умолчанию для каждого элемента управления). Добавьте следующий код в класс формы, изменив строку подключения по мере необходимости для вашей среды.

/* This does not compile, as multiple methods are missing.
// <Snippet1>
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Text;
using System.Windows.Forms;
using Microsoft.Data.SqlClient;
using System.Xml;

namespace SqlCommand_BeginExecuteXmlReaderAsync
{
    public partial class Form1 : Form
    {
        // Hook up the form's Load event handler and then add 
        // this code to the form's class:
        // You need these delegates in order to display text from a thread
        // other than the form's thread. See the HandleCallback
        // procedure for more information.
        private delegate void DisplayInfoDelegate(string Text);
        private delegate void DisplayReaderDelegate(XmlReader reader);

        private bool isExecuting;

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

        public Form1()
        {
            InitializeComponent();
        }

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

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

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

        private void ClearProductInfo()
        {
            // Clear the list box.
            this.listBox1.Items.Clear();
        }

        private void DisplayProductInfo(XmlReader reader)
        {
            // Display the data within the reader.
            while (reader.Read())
            {
                // Skip past items that are not from the correct table.
                if (reader.LocalName.ToString() == "Production.Product")
                {
                    this.listBox1.Items.Add(String.Format("{0}: {1:C}",
                        reader["Name"], Convert.ToDecimal(reader["ListPrice"])));
                }
            }
            DisplayStatus("Ready");
        }

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

        private void button1_Click(object sender, System.EventArgs e)
        {
            if (isExecuting)
            {
                MessageBox.Show(this,
                    "Already executing. Please wait until the current query " +
                    "has completed.");
            }
            else
            {
                SqlCommand command = null;
                try
                {
                    ClearProductInfo();
                    DisplayStatus("Connecting...");
                    connection = new SqlConnection(GetConnectionString());

                    // To emulate a long-running query, wait for 
                    // a few seconds before working with the data.
                    string commandText =
                        "WAITFOR DELAY '00:00:03';" +
                        "SELECT Name, ListPrice FROM Production.Product " +
                        "WHERE ListPrice < 100 " +
                        "FOR XML AUTO, XMLDATA";

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

                    DisplayStatus("Executing...");
                    isExecuting = true;
                    // Although it is not required that you pass the 
                    // SqlCommand object as the second parameter in the 
                    // BeginExecuteXmlReader call, doing so makes it easier
                    // to call EndExecuteXmlReader in the callback procedure.
                    AsyncCallback callback = new AsyncCallback(HandleCallback);
                    command.BeginExecuteXmlReader(callback, command);

                }
                catch (Exception ex)
                {
                    isExecuting = false;
                    DisplayStatus(string.Format("Ready (last error: {0})", ex.Message));
                    if (connection != null)
                    {
                        connection.Close();
                    }
                }
            }
        }

        private void HandleCallback(IAsyncResult result)
        {
            try
            {
                // Retrieve the original command object, passed
                // to this procedure in the AsyncState property
                // of the IAsyncResult parameter.
                SqlCommand command = (SqlCommand)result.AsyncState;
                XmlReader reader = command.EndExecuteXmlReader(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. 

                // 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. 
                DisplayReaderDelegate del = new DisplayReaderDelegate(DisplayProductInfo);
                this.Invoke(del, reader);

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

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

        private void Form1_Load(object sender, System.EventArgs e)
        {
            this.button1.Click += new System.EventHandler(this.button1_Click);
            this.FormClosing += new System.Windows.Forms.
                FormClosingEventHandler(this.Form1_FormClosing);
        }
    }
}
// </Snippet1>
*/

Метод BeginExecuteXmlReader запускает процесс асинхронного выполнения инструкции Transact-SQL или хранимой процедуры, возвращающей строки в формате XML, чтобы другие задачи могли выполняться одновременно при выполнении инструкции. После завершения инструкции разработчики должны вызвать EndExecuteXmlReader метод, чтобы завершить операцию и получить запрошенные XML-данные. Метод BeginExecuteXmlReader возвращается немедленно, но пока код не выполнит соответствующий EndExecuteXmlReader вызов метода, он не должен выполнять другие вызовы, запускающие синхронное или асинхронное выполнение для того же SqlCommand объекта. EndExecuteXmlReader Вызов вызова перед завершением выполнения команды приводит SqlCommand к блокировке объекта до завершения выполнения.

Обычно свойство CommandText задает оператор Transact-SQL с допустимым предложением FOR XML. CommandText Однако также можно указать инструкцию, возвращающую данные, содержащие допустимый XML. Этот метод также можно использовать для получения однострочного результирующий набор с одним столбцом. В этом случае, если возвращается несколько строк, EndExecuteXmlReader метод присоединяет XmlReader значение к первой строке и удаляет остальную часть результирующий набор.

Типичный BeginExecuteXmlReader запрос можно отформатировать, как показано в следующем примере C#:

SqlCommand command = new SqlCommand("SELECT ContactID, FirstName, LastName FROM Contact FOR XML AUTO, XMLDATA", SqlConn);

Этот метод также можно использовать для получения однострочного результирующий набор с одним столбцом. В этом случае, если возвращается несколько строк, EndExecuteXmlReader метод присоединяет XmlReader значение к первой строке и удаляет остальную часть результирующий набор.

Функция нескольких активных результирующих наборов (MARS) позволяет нескольким действиям использовать одно и то же подключение.

Параметр callback позволяет указать AsyncCallback делегат, который вызывается при завершении инструкции. Метод можно вызвать EndExecuteXmlReader из этой процедуры делегата или из любого другого расположения в приложении. Кроме того, можно передать любой объект в параметре, а процедура обратного stateObject вызова может получить эти сведения с помощью AsyncState свойства.

Все ошибки, возникающие во время выполнения операции, возникают в виде исключений в процедуре обратного вызова. Необходимо обработать исключение в процедуре обратного вызова, а не в основном приложении. Дополнительные сведения об обработке исключений в процедуре обратного вызова см. в примере в этом разделе.

Если вы используете ExecuteReader или BeginExecuteReader используете XML-данные, SQL Server вернет все результаты XML, превышающие 2033 символов длиной в нескольких строках из 2033 символов. Чтобы избежать этого поведения, используйте ExecuteXmlReader или BeginExecuteXmlReader считывает запросы FOR XML.

Этот метод игнорирует CommandTimeout свойство.

См. также раздел

Применяется к

BeginExecuteReader(AsyncCallback, Object, CommandBehavior)

Исходный код:: SqlCommand.cs

Исходный код:: SqlCommand.cs

Исходный код:: SqlCommand.cs

Исходный код:: SqlCommand.cs

Инициирует асинхронное выполнение инструкции Transact-SQL или хранимой процедуры, описываемой этим SqlCommand, с помощью одного из них CommandBehavior значения и получение одного или нескольких результирующих наборов с сервера с учетом процедуры обратного вызова и сведений о состоянии.

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

Параметры

callback: AsyncCallback

stateObject: Object

behavior: CommandBehavior

Одно из CommandBehavior значений, указывающее параметры выполнения инструкций и извлечения данных.

Возвращаемое значение

IAsyncResult

Можно IAsyncResult использовать для опроса или ожидания результатов. Это значение также необходимо при вызове EndExecuteReader(IAsyncResult) , которое возвращает SqlDataReader экземпляр, который можно использовать для получения возвращаемых строк.

Исключения

InvalidCastException

–или–

Если SqlDbType задано Value TextReader значение "Char", "NChar", "NVarChar", "VarChar" или "Xml"

–или–

Значение SqlDbType , отличное от xml , использовалось при Value установке XmlReader .

SqlException

Любая ошибка, которая произошла при выполнении текста команды.

–или–

InvalidOperationException

- or -

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

IOException

ObjectDisposedException

Примеры

Следующее приложение Windows демонстрирует использование метода BeginExecuteReader, выполняющего инструкцию Transact-SQL, которая включает в себя задержку в несколько секунд (эмуляция длительной команды). Так как пример выполняет команду асинхронно, форма остается адаптивной при ожидании результатов. Этот пример передает исполняемый SqlCommand объект в качестве stateObject параметра. Это делает его простым для извлечения SqlCommand объекта из процедуры обратного вызова, чтобы код смог вызвать EndExecuteReader метод, соответствующий первоначальному вызову BeginExecuteReader.

Чтобы настроить этот пример, создайте новое приложение Windows. Button Поместите элемент управления, DataGridView элемент управления и Label элемент управления в форму (принимая имя по умолчанию для каждого элемента управления). Добавьте следующий код в класс формы, изменив строку подключения по мере необходимости для вашей среды.

Этот пример передает CommandBehavior.CloseConnection значение в параметре behavior , что SqlDataReader приводит к автоматическому закрытию подключения при закрытии.

#if NETFRAMEWORK
#nullable enable

// <Snippet1>
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Text;
using System.Windows.Forms;
using Microsoft.Data.SqlClient;

namespace SqlCommand_BeginExecuteReaderAsyncBehavior
{
    public partial class Form1 : Form
    {
        public Form1()
        {
            InitializeComponent();
            this.label1 = new Label();
            this.dataGridView1 = new DataGridView();
            this.button1 = new Button();
        }

        private void 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 Label label1 { get; set; }

        private DataGridView dataGridView1 { get; set; }

        private Button button1 { get; set; }

        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.

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

        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;
            }
        }
    }
}
// </Snippet1>
#endif

Метод BeginExecuteReader запускает процесс асинхронного выполнения инструкции Transact-SQL или хранимой процедуры, возвращающей строки, чтобы другие задачи могли выполняться одновременно при выполнении инструкции. После завершения инструкции разработчики должны вызвать EndExecuteReader метод, чтобы завершить операцию и получить SqlDataReader возвращенную командой команду. Метод BeginExecuteReader возвращается немедленно, но пока код не выполнит соответствующий EndExecuteReader вызов метода, он не должен выполнять другие вызовы, запускающие синхронное или асинхронное выполнение для того же SqlCommand объекта. EndExecuteReader Вызов вызова перед завершением выполнения команды приводит SqlCommand к блокировке объекта до завершения выполнения.

Параметр callback позволяет указать AsyncCallback делегат, который вызывается при завершении инструкции. Метод можно вызвать EndExecuteReader из этой процедуры делегата или из любого другого расположения в приложении. Кроме того, можно передать любой объект в параметре, а процедура обратного stateObject вызова может получить эти сведения с помощью AsyncState свойства.

Параметр behavior позволяет указать параметры, управляющие поведением команды и его подключением. Эти значения можно объединить (с помощью оператора языка Or программирования); как правило, разработчики используют CloseConnection значение, чтобы убедиться, что соединение закрыто средой выполнения при закрытии SqlDataReader . Разработчики также могут оптимизировать поведение, SqlDataReader указав SingleRow значение, если известно заранее, что инструкция Transact-SQL или хранимая процедура возвращает только одну строку.

Обратите внимание, что текст команды и параметры отправляются серверу синхронно. Если отправляется большая команда или множество параметров, этот метод может блокироваться во время записи. После отправки команды метод возвращается немедленно, не ожидая ответа от сервера, то есть операции чтения асинхронны. Хотя выполнение команды является асинхронным, получение значений по-прежнему синхронно. Это означает, что вызовы Read могут блокироваться, если требуются дополнительные данные и блоки операций чтения базовой сети.

Так как процедура обратного вызова выполняется из фонового потока, предоставленного средой CLR Microsoft .NET, очень важно использовать строгий подход к обработке взаимодействия между потоками из приложения. Например, вы не должны взаимодействовать с содержимым формы из процедуры обратного вызова, если необходимо обновить форму, необходимо вернуться к потоку формы, чтобы выполнить свою работу. В примере в этом разделе показано это поведение.

Этот метод игнорирует CommandTimeout свойство.

Применяется к

SqlCommand.BeginExecuteReader Метод

Определение

Перегрузки

BeginExecuteReader()

Возвращаемое значение

Исключения

Примеры

Комментарии

Применяется к

BeginExecuteReader(CommandBehavior)

Параметры

Возвращаемое значение

Исключения

Примеры

Комментарии

Применяется к

BeginExecuteReader(AsyncCallback, Object)

Параметры

Возвращаемое значение

Исключения

Примеры

Комментарии

См. также раздел

Применяется к

BeginExecuteReader(AsyncCallback, Object, CommandBehavior)

Параметры

Возвращаемое значение

Исключения

Примеры

Комментарии

Применяется к