SqlCommand.BeginExecuteXmlReader Método
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Inicia a execução assíncrona da instrução Transact-SQL ou do procedimento armazenado descrito por este SqlCommand e retorna resultados como um objeto XmlReader.
Sobrecargas
| BeginExecuteXmlReader() |
Inicia a execução assíncrona da instrução Transact-SQL ou do procedimento armazenado descrito por este SqlCommand e retorna resultados como um objeto XmlReader. |
| BeginExecuteXmlReader(AsyncCallback, Object) |
Inicia a execução assíncrona da instrução Transact-SQL ou do procedimento armazenado descrito por este SqlCommand e retorna resultados como um objeto XmlReader usando um procedimento de retorno de chamada. |
BeginExecuteXmlReader()
Inicia a execução assíncrona da instrução Transact-SQL ou do procedimento armazenado descrito por este SqlCommand e retorna resultados como um objeto XmlReader.
public:
IAsyncResult ^ BeginExecuteXmlReader();public IAsyncResult BeginExecuteXmlReader ();member this.BeginExecuteXmlReader : unit -> IAsyncResultPublic Function BeginExecuteXmlReader () As IAsyncResultRetornos
Um IAsyncResult que pode ser usado para sondar ou aguardar resultados ou ambos. Esse valor também é necessário ao invocar EndExecuteXmlReader, que retorna um valor único de XML.
Exceções
Um SqlDbType diferente de Binary ou VarBinary foi usado quando Value foi definido como Stream. Para saber mais sobre o streaming, consulte SqlClient Streaming Support (Suporte de streaming do SqlClient).
- ou -
Um SqlDbType diferente de Char, NChar, NVarChar, VarChar ou Xml foi usado quando Value foi definido como TextReader.
- ou -
Um SqlDbType diferente de Xml foi usado quando Value foi definido como XmlReader.
Qualquer erro ocorrido ao executar o texto do comando.
- ou -
Ocorreu um tempo limite durante uma operação de streaming. Para saber mais sobre o streaming, consulte SqlClient Streaming Support (Suporte de streaming do SqlClient).
O par nome-valor "Asynchronous Processing=true" não foi incluído na cadeia de conexão que define a conexão para este SqlCommand.
- ou -
O SqlConnection foi fechado ou removido durante uma operação de streaming. Para saber mais sobre o streaming, consulte SqlClient Streaming Support (Suporte de streaming do SqlClient).
Ocorreu um erro em um objeto Stream, XmlReader ou TextReader durante uma operação de streaming. Para saber mais sobre o streaming, consulte SqlClient Streaming Support (Suporte de streaming do SqlClient).
O objeto Stream, XmlReader ou TextReader foi fechado durante uma operação de streaming. Para saber mais sobre o streaming, consulte SqlClient Streaming Support (Suporte de streaming do SqlClient).
Exemplos
O aplicativo de console a seguir inicia o processo de recuperação de dados XML de forma assíncrona. Enquanto aguarda os resultados, esse aplicativo simples fica em um loop, investigando o valor da IsCompleted propriedade. Depois que o processo for concluído, o código recuperará o XML e exibirá seu conteúdo.
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
Comentários
O BeginExecuteXmlReader método inicia o processo de execução assíncrona de uma instrução Transact-SQL que retorna linhas como XML, para que outras tarefas possam ser executadas simultaneamente enquanto a instrução está em execução. Quando a instrução for concluída, os desenvolvedores deverão chamar o EndExecuteXmlReader método para concluir a operação e recuperar o XML retornado pelo comando . O BeginExecuteXmlReader método retorna imediatamente, mas até que o código execute a chamada de método correspondente EndExecuteXmlReader , ele não deve executar nenhuma outra chamada que inicie uma execução síncrona ou assíncrona no mesmo SqlCommand objeto. Chamar o EndExecuteXmlReader antes que a execução do comando seja concluída faz com que o SqlCommand objeto seja bloqueado até que a execução seja concluída.
A CommandText propriedade normalmente especifica uma instrução Transact-SQL com uma cláusula FOR XML válida. No entanto, CommandText também pode especificar uma instrução que retorna ntext dados que contêm XML válido.
Uma consulta típica BeginExecuteXmlReader pode ser formatada como no exemplo de C# a seguir:
SqlCommand command = new SqlCommand("SELECT ContactID, FirstName, LastName FROM dbo.Contact FOR XML AUTO, XMLDATA", SqlConn);
Esse método também pode ser usado para recuperar um conjunto de resultados de linha única e de coluna única. Nesse caso, se mais de uma linha for retornada, o EndExecuteXmlReader método anexa o XmlReader ao valor na primeira linha e descarta o restante do conjunto de resultados.
O recurso MARS (conjunto de resultados ativo múltiplo) permite que várias ações usem a mesma conexão.
Observe que o texto do comando e os parâmetros são enviados para o servidor de forma síncrona. Se um comando grande ou muitos parâmetros forem enviados, esse método poderá ser bloqueado durante as gravações. Depois que o comando é enviado, o método retorna imediatamente sem aguardar uma resposta do servidor, ou seja, as leituras são assíncronas. Embora a execução de comando seja assíncrona, a busca de valor ainda é síncrona.
Como essa sobrecarga não dá suporte a um procedimento de retorno de chamada, os desenvolvedores precisam sondar para determinar se o comando foi concluído, usando a IsCompleted propriedade do IAsyncResult retornado pelo BeginExecuteXmlReader método ou aguardar a conclusão de um ou mais comandos usando a AsyncWaitHandle propriedade do retornado IAsyncResult.
Se você usar ExecuteReader ou BeginExecuteReader acessar dados XML, SQL Server retornará qualquer resultado XML maior que 2.033 caracteres de comprimento em várias linhas de 2.033 caracteres cada. Para evitar esse comportamento, use ExecuteXmlReader ou BeginExecuteXmlReader leia consultas FOR XML.
Esse método ignora a CommandTimeout propriedade .
Confira também
- Conectando e recuperando dados em ADO.NET
- Usando o provedor de dados .NET Framework para SQL Server
- Visão geral do ADO.NET
Aplica-se a
BeginExecuteXmlReader(AsyncCallback, Object)
Inicia a execução assíncrona da instrução Transact-SQL ou do procedimento armazenado descrito por este SqlCommand e retorna resultados como um objeto XmlReader usando um procedimento de retorno de chamada.
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 IAsyncResultParâmetros
- callback
- AsyncCallback
Um delegado AsyncCallback invocado quando a execução do comando for concluída. Passe null (Nothing no Microsoft Visual Basic) para indicar que não é necessário um retorno de chamada.
- stateObject
- Object
Um objeto de estado definido pelo usuário passado para o procedimento de retorno de chamada. Recupere esse objeto de dentro do procedimento de retorno de chamada usando a propriedade AsyncState.
Retornos
Um IAsyncResult que pode ser usado para sondar, aguardar resultados ou ambos. Esse valor também é necessário ao chamar EndExecuteXmlReader(IAsyncResult), que retorna os resultados do comando como XML.
Exceções
Um SqlDbType diferente de Binary ou VarBinary foi usado quando Value foi definido como Stream. Para saber mais sobre o streaming, consulte SqlClient Streaming Support (Suporte de streaming do SqlClient).
- ou -
Um SqlDbType diferente de Char, NChar, NVarChar, VarChar ou Xml foi usado quando Value foi definido como TextReader.
- ou -
Um SqlDbType diferente de Xml foi usado quando Value foi definido como XmlReader.
Qualquer erro ocorrido ao executar o texto do comando.
- ou -
Ocorreu um tempo limite durante uma operação de streaming. Para saber mais sobre o streaming, consulte SqlClient Streaming Support (Suporte de streaming do SqlClient).
O par nome-valor "Asynchronous Processing=true" não foi incluído na cadeia de conexão que define a conexão para este SqlCommand.
- ou -
O SqlConnection foi fechado ou removido durante uma operação de streaming. Para saber mais sobre o streaming, consulte SqlClient Streaming Support (Suporte de streaming do SqlClient).
Ocorreu um erro em um objeto Stream, XmlReader ou TextReader durante uma operação de streaming. Para saber mais sobre o streaming, consulte SqlClient Streaming Support (Suporte de streaming do SqlClient).
O objeto Stream, XmlReader ou TextReader foi fechado durante uma operação de streaming. Para saber mais sobre o streaming, consulte SqlClient Streaming Support (Suporte de streaming do SqlClient).
Exemplos
O aplicativo do Windows a seguir demonstra o uso do método BeginExecuteXmlReader, executando uma instrução Transact-SQL que inclui um atraso de alguns segundos (emulando um comando de longa execução). Este exemplo passa o objeto em execução como o stateObject parâmetro – isso torna simples recuperar o SqlCommand objeto de dentro do procedimento de retorno de chamada, para que o código possa chamar o EndExecuteXmlReader método correspondente à chamada inicial para BeginExecuteXmlReader.SqlCommand
Este exemplo demonstra muitas técnicas importantes. Isso inclui chamar um método que interage com o formulário de um thread separado. Além disso, este exemplo demonstra como você deve impedir que os usuários executem um comando várias vezes simultaneamente e como você deve garantir que o formulário não seja fechado antes que o procedimento de retorno de chamada seja chamado.
Para configurar este exemplo, crie um aplicativo do Windows. Coloque um Button controle, um ListBox controle e um Label controle no formulário (aceitando o nome padrão para cada controle). Adicione o código a seguir à classe do formulário, modificando o cadeia de conexão conforme necessário para seu ambiente.
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
Comentários
O BeginExecuteXmlReader método inicia o processo de execução assíncrona de uma instrução Transact-SQL ou um procedimento armazenado que retorna linhas como XML, para que outras tarefas possam ser executadas simultaneamente enquanto a instrução está sendo executada. Quando a instrução for concluída, os desenvolvedores deverão chamar o EndExecuteXmlReader método para concluir a operação e recuperar os dados XML solicitados. O BeginExecuteXmlReader método retorna imediatamente, mas até que o código execute a chamada de método correspondente EndExecuteXmlReader , ele não deve executar nenhuma outra chamada que inicie uma execução síncrona ou assíncrona no mesmo SqlCommand objeto. Chamar o EndExecuteXmlReader antes que a execução do comando seja concluída faz com que o SqlCommand objeto seja bloqueado até que a execução seja concluída.
A CommandText propriedade normalmente especifica uma instrução Transact-SQL com uma cláusula FOR XML válida. No entanto, CommandText também pode especificar uma instrução que retorna dados que contêm XML válido. Esse método também pode ser usado para recuperar um conjunto de resultados de linha única e de coluna única. Nesse caso, se mais de uma linha for retornada, o EndExecuteXmlReader método anexa o XmlReader ao valor na primeira linha e descarta o restante do conjunto de resultados.
Uma consulta típica BeginExecuteXmlReader pode ser formatada como no exemplo de C# a seguir:
SqlCommand command = new SqlCommand("SELECT ContactID, FirstName, LastName FROM Contact FOR XML AUTO, XMLDATA", SqlConn);
Esse método também pode ser usado para recuperar um conjunto de resultados de linha única e de coluna única. Nesse caso, se mais de uma linha for retornada, o EndExecuteXmlReader método anexa o XmlReader ao valor na primeira linha e descarta o restante do conjunto de resultados.
O recurso MARS (conjunto de resultados ativo múltiplo) permite que várias ações usem a mesma conexão.
O callback parâmetro permite que você especifique um AsyncCallback delegado chamado quando a instrução for concluída. Você pode chamar o EndExecuteXmlReader método de dentro desse procedimento delegado ou de qualquer outro local em seu aplicativo. Além disso, você pode passar qualquer objeto no parâmetro e o stateObject procedimento de retorno de chamada pode recuperar essas informações usando a AsyncState propriedade .
Observe que o texto do comando e os parâmetros são enviados para o servidor de forma síncrona. Se um comando grande ou muitos parâmetros for enviado, esse método poderá ser bloqueado durante as gravações. Depois que o comando é enviado, o método retorna imediatamente sem aguardar uma resposta do servidor, ou seja, as leituras são assíncronas.
Todos os erros que ocorrem durante a execução da operação são gerados como exceções no procedimento de retorno de chamada. Você deve lidar com a exceção no procedimento de retorno de chamada, não no aplicativo main. Consulte o exemplo neste tópico para obter informações adicionais sobre como lidar com exceções no procedimento de retorno de chamada.
Se você usar ExecuteReader ou BeginExecuteReader acessar dados XML, SQL Server retornará resultados XML maiores que 2.033 caracteres em várias linhas de 2.033 caracteres cada. Para evitar esse comportamento, use ExecuteXmlReader ou BeginExecuteXmlReader leia consultas FOR XML.
Esse método ignora a CommandTimeout propriedade .
