SqlCommand.BeginExecuteXmlReader Метод
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Инициирует асинхронное выполнение инструкции Transact-SQL или хранимой процедуры, определенной в данном объекте SqlCommand, и возвращает результаты в виде объекта XmlReader.
Перегрузки
| BeginExecuteXmlReader() |
Инициирует асинхронное выполнение инструкции Transact-SQL или хранимой процедуры, определенной в данном объекте SqlCommand, и возвращает результаты в виде объекта XmlReader. |
| BeginExecuteXmlReader(AsyncCallback, Object) |
Инициирует асинхронное выполнение инструкции Transact-SQL или хранимой процедуры, определенной в данном объекте SqlCommand, и возвращает результаты в виде объекта XmlReader, используя процедуру обратного вызова. |
BeginExecuteXmlReader()
- Исходный код:
- System.Data.SqlClient.notsupported.cs
Инициирует асинхронное выполнение инструкции Transact-SQL или хранимой процедуры, определенной в данном объекте SqlCommand, и возвращает результаты в виде объекта XmlReader.
public:
IAsyncResult ^ BeginExecuteXmlReader();public IAsyncResult BeginExecuteXmlReader ();member this.BeginExecuteXmlReader : unit -> IAsyncResultPublic Function BeginExecuteXmlReader () As IAsyncResultВозвращаемое значение
Объект IAsyncResult, который может использоваться для запроса или ожидания результатов или для того и другого; это значение требуется также при вызове метода EndExecuteXmlReader, возвращающего одно XML-значение.
Исключения
Если SqlDbType для параметра задано значение Stream, отличное от Binary или VarBinary, использовалось Value значение . Дополнительные сведения о потоковой передаче см. в разделе Поддержка потоковой передачи SqlClient.
-или-
Если SqlDbType для параметра задано значение TextReader, кроме Char, NChar, NVarChar, VarChar или Xml, использовался объект , отличный от ValueChar, NChar, NVarChar, VarChar или Xml.
-или-
Объект , отличный SqlDbType от XML , использовался, когда Value для параметра задано значение XmlReader.
Любая ошибка, произошедшая во время выполнения текста команды.
-или-
Во время операции потоковой передачи истекло время ожидания. Дополнительные сведения о потоковой передаче см. в разделе Поддержка потоковой передачи SqlClient.
Пара имя — значение (Asynchronous Processing=true) не была указана в строке подключения, определяющей подключение для этого SqlCommand.
-или-
Подключение SqlConnection, закрытое или удаленное во время операции потоковой передачи. Дополнительные сведения о потоковой передаче см. в разделе Поддержка потоковой передачи SqlClient.
Во время операции потоковой передачи возникла ошибка в объекте Stream, XmlReader или TextReader. Дополнительные сведения о потоковой передаче см. в разделе Поддержка потоковой передачи SqlClient.
Объект Stream, XmlReader или TextReader был закрыт во время операции потоковой передачи. Дополнительные сведения о потоковой передаче см. в разделе Поддержка потоковой передачи SqlClient.
Примеры
Следующее консольное приложение запускает процесс асинхронного извлечения XML-данных. В ожидании результатов это простое приложение находится в цикле, исследуя IsCompleted значение свойства. После завершения процесса код извлекает XML и отображает его содержимое.
using System.Data.SqlClient;
using System.Xml;
class Class1
{
static void Main()
{
// This example is not terribly effective, 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 Name, ListPrice FROM Production.Product " +
"WHERE ListPrice < 100 " +
"FOR XML AUTO, XMLDATA";
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))
{
SqlCommand command = new SqlCommand(commandText, connection);
connection.Open();
IAsyncResult result = command.BeginExecuteXmlReader();
// 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.
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);
}
XmlReader reader = command.EndExecuteXmlReader(result);
DisplayProductInfo(reader);
}
}
private static 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")
{
Console.WriteLine("{0}: {1:C}",
reader["Name"], Convert.ToSingle(reader["ListPrice"]));
}
}
}
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
Imports System.Xml
Module Module1
Sub Main()
' This example is not terribly effective, 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 Name, ListPrice FROM Production.Product " & _
"WHERE ListPrice < 100 " & _
"FOR XML AUTO, XMLDATA"
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.BeginExecuteXmlReader()
' 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 = 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
Using reader As XmlReader = command.EndExecuteXmlReader(result)
DisplayProductInfo(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 DisplayProductInfo(ByVal reader As XmlReader)
' 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" Then
Console.WriteLine("{0}: {1:C}", _
reader("Name"), CSng(reader("ListPrice")))
End If
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
Комментарии
Метод BeginExecuteXmlReader запускает процесс асинхронного выполнения инструкции Transact-SQL, которая возвращает строки в виде XML, чтобы другие задачи могли выполняться параллельно во время выполнения инструкции. После завершения инструкции разработчики должны вызвать EndExecuteXmlReader метод , чтобы завершить операцию и получить XML-код, возвращенный командой . Метод BeginExecuteXmlReader возвращает немедленно, но пока код не выполнит соответствующий EndExecuteXmlReader вызов метода, он не должен выполнять другие вызовы, запускающие синхронное или асинхронное выполнение для того же SqlCommand объекта.
EndExecuteXmlReader Вызов до завершения выполнения команды приводит к блокировке SqlCommand объекта до завершения выполнения.
Свойство CommandText обычно задает инструкцию Transact-SQL с допустимым предложением FOR XML.
CommandText Однако может также указать инструкцию, которая возвращает ntext данные, содержащие допустимый XML-код.
Типичный BeginExecuteXmlReader запрос можно отформатировать, как показано в следующем примере C#:
SqlCommand command = new SqlCommand("SELECT ContactID, FirstName, LastName FROM dbo.Contact FOR XML AUTO, XMLDATA", SqlConn);
Этот метод также можно использовать для получения однострочного результирующий набор с одним столбцом. В этом случае, если возвращается несколько строк, EndExecuteXmlReader метод присоединяет XmlReader к значению в первой строке и удаляет остальную часть результированного набора.
Функция MARS позволяет нескольким действиям использовать одно и то же подключение.
Обратите внимание, что текст команды и параметры отправляются на сервер синхронно. Если отправляется большая команда или много параметров, этот метод может блокироваться во время записи. После отправки команды метод возвращается немедленно, не ожидая ответа от сервера, то есть операции чтения являются асинхронными. Хотя выполнение команды является асинхронным, получение значений по-прежнему является синхронным.
Так как эта перегрузка не поддерживает процедуру обратного вызова, разработчикам необходимо либо выполнить опрос, чтобы определить, выполнена ли команда, используя IsCompleted свойство возвращаемого IAsyncResult методом BeginExecuteXmlReader , либо дождаться завершения одной или нескольких команд с помощью AsyncWaitHandle свойства возвращаемого IAsyncResultобъекта .
Если вы используете ExecuteReader или BeginExecuteReader для доступа к XML-данным, SQL Server возвращает любые результаты XML длиной более 2033 символов в нескольких строках по 2033 символа каждый. Чтобы избежать такого поведения, используйте ExecuteXmlReader или BeginExecuteXmlReader для чтения запросов FOR XML.
Этот метод игнорирует CommandTimeout свойство .
См. также раздел
- Подключение и получение данных в ADO.NET
- Использование поставщика данных платформа .NET Framework для SQL Server
- Общие сведения об ADO.NET
Применяется к
BeginExecuteXmlReader(AsyncCallback, Object)
- Исходный код:
- System.Data.SqlClient.notsupported.cs
Инициирует асинхронное выполнение инструкции Transact-SQL или хранимой процедуры, определенной в данном объекте SqlCommand, и возвращает результаты в виде объекта XmlReader, используя процедуру обратного вызова.
public:
IAsyncResult ^ BeginExecuteXmlReader(AsyncCallback ^ callback, System::Object ^ stateObject);public IAsyncResult BeginExecuteXmlReader (AsyncCallback callback, object stateObject);member this.BeginExecuteXmlReader : AsyncCallback * obj -> IAsyncResultPublic Function BeginExecuteXmlReader (callback As AsyncCallback, stateObject As Object) As IAsyncResultПараметры
- callback
- AsyncCallback
Делегат AsyncCallback, вызываемый по завершении выполнения команды. Передайте значение null (Nothing в Microsoft Visual Basic), чтобы указать, что обратный вызов не требуется.
- stateObject
- Object
Определяемый пользователем объект состояния, передаваемый процедуре обратного вызова. Извлечение этого объекта в процедуре обратного вызова осуществляется посредством свойства AsyncState.
Возвращаемое значение
Объект IAsyncResult, который может использоваться для запроса или ожидания результатов или для того и другого; это значение требуется также при вызове метода EndExecuteXmlReader(IAsyncResult), возвращающего результаты выполнения команды в виде XML.
Исключения
Если SqlDbType для параметра задано значение Stream, отличное от Binary или VarBinary, использовалось Value значение . Дополнительные сведения о потоковой передаче см. в разделе Поддержка потоковой передачи SqlClient.
-или-
Если SqlDbType для параметра задано значение TextReader, кроме Char, NChar, NVarChar, VarChar или Xml, использовался объект , отличный от ValueChar, NChar, NVarChar, VarChar или Xml.
-или-
Объект , отличный SqlDbType от XML , использовался, когда Value для параметра задано значение XmlReader.
Любая ошибка, произошедшая во время выполнения текста команды.
-или-
Во время операции потоковой передачи истекло время ожидания. Дополнительные сведения о потоковой передаче см. в разделе Поддержка потоковой передачи SqlClient.
Пара имя — значение (Asynchronous Processing=true) не была указана в строке подключения, определяющей подключение для этого SqlCommand.
-или-
Подключение SqlConnection, закрытое или удаленное во время операции потоковой передачи. Дополнительные сведения о потоковой передаче см. в разделе Поддержка потоковой передачи SqlClient.
Во время операции потоковой передачи возникла ошибка в объекте Stream, XmlReader или TextReader. Дополнительные сведения о потоковой передаче см. в разделе Поддержка потоковой передачи SqlClient.
Объект Stream, XmlReader или TextReader был закрыт во время операции потоковой передачи. Дополнительные сведения о потоковой передаче см. в разделе Поддержка потоковой передачи SqlClient.
Примеры
Следующее приложение Windows демонстрирует использование метода BeginExecuteXmlReader, выполняющего инструкцию Transact-SQL, которая включает в себя задержку в несколько секунд (эмуляция длительной команды). В этом примере выполняется SqlCommand передача объекта в качестве stateObject параметра, что упрощает извлечение SqlCommand объекта из процедуры обратного вызова, чтобы код смог вызвать EndExecuteXmlReader метод, соответствующий первоначальному вызову BeginExecuteXmlReader.
В этом примере демонстрируется множество важных методов. Сюда входит вызов метода, который взаимодействует с формой из отдельного потока. Кроме того, в этом примере показано, как запретить пользователям выполнять команду несколько раз одновременно и как убедиться, что форма не закрывается до вызова процедуры обратного вызова.
Чтобы настроить этот пример, создайте новое приложение Windows. Поместите элемент Button управления, ListBox элемент управления и Label элемент управления в форму (принимая имена по умолчанию для каждого элемента управления). Добавьте следующий код в класс формы, изменив строка подключения по мере необходимости для вашей среды.
using System.Data.SqlClient;
using System.Xml;
namespace Microsoft.AdoDotNet.CodeSamples
{
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.
// 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 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);
}
}
}
Imports System.Data.SqlClient
Imports System.Xml
Public Class Form1
' 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 Sub DisplayInfoDelegate(ByVal Text As String)
Private Delegate Sub DisplayReaderDelegate(ByVal reader As XmlReader)
Private isExecuting As Boolean
' This example maintains the connection object
' externally, so that it is available for closing.
Private connection As SqlConnection
Private Function GetConnectionString() As String
' To avoid storing the connection string in your code,
' you can retrieve it from a configuration file.
' If you have not included "Asynchronous Processing=true" in the
' connection string, the command is not able
' to execute asynchronously.
Return "Data Source=(local);Integrated Security=true;" & _
"Initial Catalog=AdventureWorks; Asynchronous Processing=true"
End Function
Private Sub DisplayStatus(ByVal Text As String)
Me.Label1.Text = Text
End Sub
Private Sub ClearProductInfo()
' Clear the list box.
Me.ListBox1.Items.Clear()
End Sub
Private Sub DisplayProductInfo(ByVal reader As XmlReader)
' 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" Then
Me.ListBox1.Items.Add(String.Format("{0}: {1:C}", _
reader("Name"), CSng(reader("ListPrice"))))
End If
End While
DisplayStatus("Ready")
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
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
ClearProductInfo()
DisplayStatus("Connecting...")
connection = New SqlConnection(GetConnectionString())
' To emulate a long-running query, wait for
' a few seconds before working with the data.
Dim commandText As String = _
"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.
Dim callback As New AsyncCallback(AddressOf HandleCallback)
command.BeginExecuteXmlReader(callback, command)
Catch ex As Exception
isExecuting = False
DisplayStatus(String.Format("Ready (last error: {0})", ex.Message))
If connection IsNot Nothing Then
connection.Close()
End If
End Try
End If
End Sub
Private Sub HandleCallback(ByVal result As IAsyncResult)
Try
' Retrieve the original command object, passed
' to this procedure in the AsyncState property
' of the IAsyncResult parameter.
Dim command As SqlCommand = CType(result.AsyncState, SqlCommand)
Dim reader As XmlReader = 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.
Dim del As New DisplayReaderDelegate(AddressOf DisplayProductInfo)
Me.Invoke(del, reader)
Catch ex As Exception
' Because you are now running code in a separate thread,
' if you do not handle the exception here, none of your other
' code catches the exception. Because none of
' your code is on the call stack in this thread, there is nothing
' higher up the stack to catch the exception if you do not
' handle it here. You can either log the exception or
' invoke a delegate (as in the non-error case in this
' example) to display the error on the form. In no case
' can you simply display the error without executing a delegate
' as in the Try block here.
' You can create the delegate instance as you
' invoke it, like this:
Me.Invoke(New DisplayInfoDelegate(AddressOf DisplayStatus), _
String.Format("Ready(last error: {0}", ex.Message))
Finally
isExecuting = False
If connection IsNot Nothing Then
connection.Close()
End If
End Try
End Sub
End Class
Комментарии
Метод 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 свойства .
Обратите внимание, что текст команды и параметры отправляются на сервер синхронно. Если отправляется большая команда или много параметров, этот метод может блокироваться во время записи. После отправки команды метод возвращается немедленно, не ожидая ответа от сервера, то есть операции чтения являются асинхронными.
Все ошибки, возникающие во время выполнения операции, создаются как исключения в процедуре обратного вызова. Исключение необходимо обрабатывать в процедуре обратного вызова, а не в приложении main. Дополнительные сведения об обработке исключений в процедуре обратного вызова см. в примере этой статьи.
Если вы используете ExecuteReader или BeginExecuteReader для доступа к XML-данным, SQL Server вернет все XML-результаты длиной более 2033 символов в нескольких строках по 2033 символа в каждой. Чтобы избежать такого поведения, используйте ExecuteXmlReader или BeginExecuteXmlReader для чтения запросов FOR XML.
Этот метод игнорирует CommandTimeout свойство .
