SqlCommand.BeginExecuteXmlReader Metode
Definisi
Penting
Beberapa informasi terkait produk prarilis yang dapat diubah secara signifikan sebelum dirilis. Microsoft tidak memberikan jaminan, tersirat maupun tersurat, sehubungan dengan informasi yang diberikan di sini.
Memulai eksekusi asinkron dari pernyataan Transact-SQL atau prosedur tersimpan yang dijelaskan oleh ini SqlCommand dan mengembalikan hasil sebagai XmlReader objek.
Overload
| BeginExecuteXmlReader() |
Memulai eksekusi asinkron dari pernyataan Transact-SQL atau prosedur tersimpan yang dijelaskan oleh ini SqlCommand dan mengembalikan hasil sebagai XmlReader objek. |
| BeginExecuteXmlReader(AsyncCallback, Object) |
Memulai eksekusi asinkron dari pernyataan Transact-SQL atau prosedur tersimpan yang dijelaskan oleh ini SqlCommand dan mengembalikan hasil sebagai XmlReader objek, menggunakan prosedur panggilan balik. |
BeginExecuteXmlReader()
Memulai eksekusi asinkron dari pernyataan Transact-SQL atau prosedur tersimpan yang dijelaskan oleh ini SqlCommand dan mengembalikan hasil sebagai XmlReader objek.
public:
IAsyncResult ^ BeginExecuteXmlReader();public IAsyncResult BeginExecuteXmlReader ();member this.BeginExecuteXmlReader : unit -> IAsyncResultPublic Function BeginExecuteXmlReader () As IAsyncResultMengembalikan
Yang IAsyncResult dapat digunakan untuk melakukan polling atau menunggu hasil, atau keduanya; nilai ini juga diperlukan saat memanggil EndExecuteXmlReader, yang mengembalikan satu nilai XML.
Pengecualian
Selain SqlDbTypeBiner atau VarBinary digunakan ketika Value diatur ke Stream. Untuk informasi selengkapnya tentang streaming, lihat Dukungan Streaming SqlClient.
-atau-
Selain SqlDbTypeChar, NChar, NVarChar, VarChar, atau Xml digunakan saat Value diatur ke TextReader.
-atau-
Selain SqlDbTypeXml digunakan ketika Value diatur ke XmlReader.
Kesalahan apa pun yang terjadi saat menjalankan teks perintah.
-atau-
Waktu habis terjadi selama operasi streaming. Untuk informasi selengkapnya tentang streaming, lihat Dukungan Streaming SqlClient.
Pasangan nama/nilai "Pemrosesan Asinkron=true" tidak disertakan dalam string koneksi mendefinisikan koneksi untuk ini SqlCommand.
-atau-
Ditutup SqlConnection atau dihilangkan selama operasi streaming. Untuk informasi selengkapnya tentang streaming, lihat Dukungan Streaming SqlClient.
Terjadi kesalahan dalam Streamobjek , XmlReader atau TextReader selama operasi streaming. Untuk informasi selengkapnya tentang streaming, lihat Dukungan Streaming SqlClient.
Objek Stream, XmlReader atau TextReader ditutup selama operasi streaming. Untuk informasi selengkapnya tentang streaming, lihat Dukungan Streaming SqlClient.
Contoh
Aplikasi konsol berikut memulai proses pengambilan data XML secara asinkron. Saat menunggu hasilnya, aplikasi sederhana ini berada dalam perulangan, menyelidiki IsCompleted nilai properti. Setelah proses selesai, kode mengambil XML dan menampilkan kontennya.
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
Keterangan
Metode ini BeginExecuteXmlReader memulai proses menjalankan pernyataan Transact-SQL secara asinkron yang mengembalikan baris sebagai XML, sehingga tugas lain dapat berjalan bersamaan saat pernyataan dijalankan. Ketika pernyataan telah selesai, pengembang harus memanggil EndExecuteXmlReader metode untuk menyelesaikan operasi dan mengambil XML yang dikembalikan oleh perintah . Metode ini BeginExecuteXmlReader segera kembali, tetapi sampai kode menjalankan panggilan metode yang EndExecuteXmlReader sesuai, metode tersebut tidak boleh menjalankan panggilan lain yang memulai eksekusi sinkron atau asinkron terhadap objek yang sama SqlCommand . Memanggil EndExecuteXmlReader sebelum eksekusi perintah selesai menyebabkan objek diblokir SqlCommand hingga eksekusi selesai.
Properti CommandText biasanya menentukan pernyataan Transact-SQL dengan klausa FOR XML yang valid. Namun, CommandText juga dapat menentukan pernyataan yang mengembalikan ntext data yang berisi XML yang valid.
Kueri umum BeginExecuteXmlReader dapat diformat seperti dalam contoh C# berikut:
SqlCommand command = new SqlCommand("SELECT ContactID, FirstName, LastName FROM dbo.Contact FOR XML AUTO, XMLDATA", SqlConn);
Metode ini juga dapat digunakan untuk mengambil kumpulan hasil satu baris kolom tunggal. Dalam hal ini, jika lebih dari satu baris dikembalikan, EndExecuteXmlReader metode melampirkan XmlReader ke nilai pada baris pertama, dan membuang sisa kumpulan hasil.
Fitur beberapa tataan hasil aktif (MARS) memungkinkan beberapa tindakan menggunakan koneksi yang sama.
Perhatikan bahwa teks perintah dan parameter dikirim ke server secara sinkron. Jika perintah besar atau banyak parameter dikirim, metode ini dapat memblokir selama penulisan. Setelah perintah dikirim, metode segera kembali tanpa menunggu jawaban dari server--yaitu, bacaan bersifat asinkron. Meskipun eksekusi perintah tidak sinkron, pengambilan nilai masih sinkron.
Karena kelebihan beban ini tidak mendukung prosedur panggilan balik, pengembang perlu melakukan polling untuk menentukan apakah perintah telah selesai, menggunakan IsCompleted properti dari IAsyncResult yang dikembalikan oleh BeginExecuteXmlReader metode ; atau menunggu penyelesaian satu atau beberapa perintah menggunakan AsyncWaitHandle properti dari yang dikembalikan IAsyncResult.
Jika Anda menggunakan ExecuteReader atau BeginExecuteReader untuk mengakses data XML, SQL Server mengembalikan hasil XML apa pun yang panjangnya lebih dari 2.033 karakter dalam beberapa baris masing-masing 2.033 karakter. Untuk menghindari perilaku ini, gunakan ExecuteXmlReader atau BeginExecuteXmlReader untuk membaca kueri XML FOR.
Metode ini mengabaikan CommandTimeout properti .
Lihat juga
- Menyambungkan dan Mengambil Data di ADO.NET
- Menggunakan Penyedia Data .NET Framework untuk SQL Server
- Ringkasan ADO.NET
Berlaku untuk
BeginExecuteXmlReader(AsyncCallback, Object)
Memulai eksekusi asinkron dari pernyataan Transact-SQL atau prosedur tersimpan yang dijelaskan oleh ini SqlCommand dan mengembalikan hasil sebagai XmlReader objek, menggunakan prosedur panggilan balik.
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 IAsyncResultParameter
- callback
- AsyncCallback
AsyncCallback Delegasi yang dipanggil ketika eksekusi perintah telah selesai. Teruskan null (Nothing di Microsoft Visual Basic) untuk menunjukkan bahwa tidak ada panggilan balik yang diperlukan.
- stateObject
- Object
Objek status yang ditentukan pengguna yang diteruskan ke prosedur panggilan balik. Ambil objek ini dari dalam prosedur panggilan balik menggunakan AsyncState properti .
Mengembalikan
Yang IAsyncResult dapat digunakan untuk melakukan polling, menunggu hasil, atau keduanya; nilai ini juga diperlukan ketika EndExecuteXmlReader(IAsyncResult) dipanggil, yang mengembalikan hasil perintah sebagai XML.
Pengecualian
Selain SqlDbTypeBiner atau VarBinary digunakan ketika Value diatur ke Stream. Untuk informasi selengkapnya tentang streaming, lihat Dukungan Streaming SqlClient.
-atau-
Selain SqlDbTypeChar, NChar, NVarChar, VarChar, atau Xml digunakan saat Value diatur ke TextReader.
-atau-
Selain SqlDbTypeXml digunakan ketika Value diatur ke XmlReader.
Kesalahan apa pun yang terjadi saat menjalankan teks perintah.
-atau-
Waktu habis terjadi selama operasi streaming. Untuk informasi selengkapnya tentang streaming, lihat Dukungan Streaming SqlClient.
Pasangan nama/nilai "Pemrosesan Asinkron=true" tidak disertakan dalam string koneksi mendefinisikan koneksi untuk ini SqlCommand.
-atau-
Ditutup SqlConnection atau dihilangkan selama operasi streaming. Untuk informasi selengkapnya tentang streaming, lihat Dukungan Streaming SqlClient.
Terjadi kesalahan dalam Streamobjek , XmlReader atau TextReader selama operasi streaming. Untuk informasi selengkapnya tentang streaming, lihat Dukungan Streaming SqlClient.
Objek Stream, XmlReader atau TextReader ditutup selama operasi streaming. Untuk informasi selengkapnya tentang streaming, lihat Dukungan Streaming SqlClient.
Contoh
Aplikasi Windows berikut menunjukkan penggunaan metode BeginExecuteXmlReader, menjalankan pernyataan Transact-SQL yang mencakup penundaan beberapa detik (meniru perintah yang berjalan lama). Contoh ini meneruskan SqlCommand objek yang dieksekusi sebagai stateObject parameter--melakukannya memudahkan untuk mengambil SqlCommand objek dari dalam prosedur panggilan balik, sehingga kode dapat memanggil EndExecuteXmlReader metode yang sesuai dengan panggilan awal ke BeginExecuteXmlReader.
Contoh ini menunjukkan banyak teknik penting. Ini termasuk memanggil metode yang berinteraksi dengan formulir dari utas terpisah. Selain itu, contoh ini menunjukkan bagaimana Anda harus memblokir pengguna agar tidak menjalankan perintah beberapa kali secara bersamaan, dan bagaimana Anda harus memastikan bahwa formulir tidak ditutup sebelum prosedur panggilan balik dipanggil.
Untuk menyiapkan contoh ini, buat aplikasi Windows baru. Letakkan Button kontrol, ListBox kontrol, dan Label kontrol pada formulir (menerima nama default untuk setiap kontrol). Tambahkan kode berikut ke kelas formulir, memodifikasi string koneksi sesuai kebutuhan untuk lingkungan Anda.
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
Keterangan
Metode ini BeginExecuteXmlReader memulai proses menjalankan pernyataan Transact-SQL atau prosedur tersimpan secara asinkron yang mengembalikan baris sebagai XML, sehingga tugas lain dapat berjalan bersamaan saat pernyataan dijalankan. Ketika pernyataan telah selesai, pengembang harus memanggil EndExecuteXmlReader metode untuk menyelesaikan operasi dan mengambil data XML yang diminta. Metode ini BeginExecuteXmlReader segera kembali, tetapi sampai kode menjalankan panggilan metode yang EndExecuteXmlReader sesuai, metode tersebut tidak boleh menjalankan panggilan lain yang memulai eksekusi sinkron atau asinkron terhadap objek yang sama SqlCommand . Memanggil EndExecuteXmlReader sebelum eksekusi perintah selesai menyebabkan objek diblokir SqlCommand hingga eksekusi selesai.
Properti CommandText biasanya menentukan pernyataan Transact-SQL dengan klausa FOR XML yang valid. Namun, CommandText juga dapat menentukan pernyataan yang mengembalikan data yang berisi XML yang valid. Metode ini juga dapat digunakan untuk mengambil kumpulan hasil satu baris kolom tunggal. Dalam hal ini, jika lebih dari satu baris dikembalikan, EndExecuteXmlReader metode melampirkan XmlReader ke nilai pada baris pertama, dan membuang sisa kumpulan hasil.
Kueri umum BeginExecuteXmlReader dapat diformat seperti dalam contoh C# berikut:
SqlCommand command = new SqlCommand("SELECT ContactID, FirstName, LastName FROM Contact FOR XML AUTO, XMLDATA", SqlConn);
Metode ini juga dapat digunakan untuk mengambil kumpulan hasil satu baris kolom tunggal. Dalam hal ini, jika lebih dari satu baris dikembalikan, EndExecuteXmlReader metode melampirkan XmlReader ke nilai pada baris pertama, dan membuang sisa kumpulan hasil.
Fitur beberapa tataan hasil aktif (MARS) memungkinkan beberapa tindakan menggunakan koneksi yang sama.
Parameter callback memungkinkan Anda menentukan AsyncCallback delegasi yang dipanggil ketika pernyataan telah selesai. Anda dapat memanggil EndExecuteXmlReader metode dari dalam prosedur delegasi ini, atau dari lokasi lain dalam aplikasi Anda. Selain itu, Anda dapat meneruskan objek apa pun dalam stateObject parameter , dan prosedur panggilan balik Anda dapat mengambil informasi ini menggunakan AsyncState properti .
Perhatikan bahwa teks perintah dan parameter dikirim ke server secara sinkron. Jika perintah besar atau banyak parameter dikirim, metode ini dapat memblokir selama penulisan. Setelah perintah dikirim, metode segera kembali tanpa menunggu jawaban dari server--yaitu, bacaan bersifat asinkron.
Semua kesalahan yang terjadi selama eksekusi operasi dilemparkan sebagai pengecualian dalam prosedur panggilan balik. Anda harus menangani pengecualian dalam prosedur panggilan balik, bukan di aplikasi utama. Lihat contoh dalam topik ini untuk informasi tambahan tentang penanganan pengecualian dalam prosedur panggilan balik.
Jika Anda menggunakan ExecuteReader atau BeginExecuteReader untuk mengakses data XML, SQL Server akan mengembalikan hasil XML apa pun yang panjangnya lebih dari 2.033 karakter dalam beberapa baris masing-masing 2.033 karakter. Untuk menghindari perilaku ini, gunakan ExecuteXmlReader atau BeginExecuteXmlReader untuk membaca kueri XML FOR.
Metode ini mengabaikan CommandTimeout properti .
