SqlCommand.BeginExecuteXmlReader Methode
Definition
Wichtig
Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.
Initiiert die asynchrone Ausführung der Transact-SQL-Anweisung oder der gespeicherten Prozedur, die von diesem SqlCommand beschrieben wird, und gibt die Ergebnisse in Form eines XmlReader-Objekts zurück.
Überlädt
| BeginExecuteXmlReader() |
Initiiert die asynchrone Ausführung der Transact-SQL-Anweisung oder der gespeicherten Prozedur, die von diesem SqlCommand beschrieben wird, und gibt die Ergebnisse in Form eines XmlReader-Objekts zurück. |
| BeginExecuteXmlReader(AsyncCallback, Object) |
Initiiert die asynchrone Ausführung der Transact-SQL-Anweisung oder der gespeicherten Prozedur, die von diesem SqlCommand beschrieben wird, und gibt mithilfe einer Rückrufprozedur die Ergebnisse in Form eines XmlReader-Objekts zurück. |
BeginExecuteXmlReader()
Initiiert die asynchrone Ausführung der Transact-SQL-Anweisung oder der gespeicherten Prozedur, die von diesem SqlCommand beschrieben wird, und gibt die Ergebnisse in Form eines XmlReader-Objekts zurück.
public:
IAsyncResult ^ BeginExecuteXmlReader();public IAsyncResult BeginExecuteXmlReader ();member this.BeginExecuteXmlReader : unit -> IAsyncResultPublic Function BeginExecuteXmlReader () As IAsyncResultGibt zurück
Ein IAsyncResult, das zum Abfragen von Ergebnissen und/oder Warten auf Ergebnisse verwendet werden kann. Dieser Wert wird auch zum Aufrufen von EndExecuteXmlReader benötigt, der einen einzelnen XML-Wert zurückgibt.
Ausnahmen
Es wurde ein anderer SqlDbType als Binary oder VarBinary verwendet, als Value auf Stream festgelegt wurde. Weitere Informationen zum Streaming finden Sie unter SqlClient Streaming Support (SqlClient-Streamingunterstützung).
- oder -
Ein SqlDbType anderes als Char, NChar, NVarChar, VarChar oder Xml wurde verwendet, wenn Value auf TextReaderfestgelegt wurde.
- oder -
Es wurde ein anderer SqlDbType als Xml verwendet, als Value auf XmlReader festgelegt wurde.
Alle Fehler, die beim Ausführen des Befehlstexts aufgetreten sind.
- oder -
Bei einem Streamingvorgang ist ein Timeout aufgetreten. Weitere Informationen zum Streaming finden Sie unter SqlClient Streaming Support (SqlClient-Streamingunterstützung).
Das Name-Wert-Paar "Asynchronous Processing=true" war nicht in der Verbindungszeichenfolge enthalten, mit der die Verbindung für diesen SqlCommand definiert wird.
- oder -
Die SqlConnection wurde während eines Streamingvorgangs geschlossen oder getrennt. Weitere Informationen zum Streaming finden Sie unter SqlClient Streaming Support (SqlClient-Streamingunterstützung).
Während eines Streamingvorgangs ist bei einem Stream-, XmlReader- oder TextReader-Objekt ein Fehler aufgetreten. Weitere Informationen zum Streaming finden Sie unter SqlClient Streaming Support (SqlClient-Streamingunterstützung).
Das Stream-, XmlReader- oder TextReader-Objekt wurde während eines Streamingvorgangs geschlossen. Weitere Informationen zum Streaming finden Sie unter SqlClient Streaming Support (SqlClient-Streamingunterstützung).
Beispiele
Die folgende Konsolenanwendung startet den Prozess zum asynchronen Abrufen von XML-Daten. Während sie auf die Ergebnisse wartet, befindet sich diese einfache Anwendung in einer Schleife und untersucht den IsCompleted Eigenschaftswert. Nachdem der Prozess abgeschlossen ist, ruft der Code die XML ab und zeigt seinen Inhalt an.
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
Hinweise
Die BeginExecuteXmlReader -Methode startet den Prozess der asynchronen Ausführung einer Transact-SQL-Anweisung, die Zeilen als XML zurückgibt, sodass andere Aufgaben gleichzeitig ausgeführt werden können, während die Anweisung ausgeführt wird. Wenn die Anweisung abgeschlossen ist, müssen Entwickler die EndExecuteXmlReader -Methode aufrufen, um den Vorgang abzuschließen und den vom Befehl zurückgegebenen XML-Code abzurufen. Die BeginExecuteXmlReader -Methode gibt sofort zurück, aber bis der Code den entsprechenden EndExecuteXmlReader Methodenaufruf ausführt, darf sie keine anderen Aufrufe ausführen, die eine synchrone oder asynchrone Ausführung für dasselbe SqlCommand Objekt starten. Wenn Sie die EndExecuteXmlReader aufrufen, bevor die Ausführung des Befehls abgeschlossen ist, wird das SqlCommand Objekt blockiert, bis die Ausführung abgeschlossen ist.
Die CommandText -Eigenschaft gibt normalerweise eine Transact-SQL-Anweisung mit einer gültigen FOR XML-Klausel an. Kann jedoch auch eine -Anweisung angeben, CommandText die Daten zurückgibt ntext , die gültiges XML enthalten.
Eine typische BeginExecuteXmlReader Abfrage kann wie im folgenden C#-Beispiel formatiert werden:
SqlCommand command = new SqlCommand("SELECT ContactID, FirstName, LastName FROM dbo.Contact FOR XML AUTO, XMLDATA", SqlConn);
Diese Methode kann auch verwendet werden, um ein einspaltiges Resultset abzurufen. Wenn in diesem Fall mehr als eine Zeile zurückgegeben wird, fügt die EndExecuteXmlReader -Methode an XmlReader den Wert in der ersten Zeile an und verwirft den Rest des Resultsets.
Mit der Mars-Funktion (Multiple Active Result Set) können mehrere Aktionen dieselbe Verbindung verwenden.
Beachten Sie, dass der Befehlstext und die Parameter synchron an den Server gesendet werden. Wenn ein großer Befehl oder viele Parameter gesendet werden, kann diese Methode während Schreibvorgängen blockiert werden. Nachdem der Befehl gesendet wurde, gibt die Methode sofort zurück, ohne auf eine Antwort vom Server zu warten, d. h. Lesevorgänge sind asynchron. Obwohl die Befehlsausführung asynchron ist, ist das Abrufen von Werten immer noch synchron.
Da diese Überladung keine Rückrufprozedur unterstützt, müssen Entwickler entweder abfragen, um zu bestimmen, ob der Befehl abgeschlossen wurde, indem sie die IsCompleted -Eigenschaft des IAsyncResult von der BeginExecuteXmlReader -Methode zurückgegebenen verwenden, oder auf den Abschluss eines oder mehrerer Befehle mit der AsyncWaitHandle -Eigenschaft des zurückgegebenen IAsyncResultwarten.
Wenn Sie oder BeginExecuteReader für den Zugriff auf XML-Daten verwendenExecuteReader, gibt SQL Server xml-Ergebnisse mit einer Länge von mehr als 2.033 Zeichen in mehreren Zeilen mit jeweils 2.033 Zeichen zurück. Um dieses Verhalten zu vermeiden, verwenden Sie ExecuteXmlReader oder BeginExecuteXmlReader , um FOR XML-Abfragen zu lesen.
Diese Methode ignoriert die CommandTimeout -Eigenschaft.
Weitere Informationen
- Verbinden und Abrufen von Daten in ADO.NET
- Verwenden des .NET Framework-Datenanbieters für SQL Server
- Übersicht über ADO.NET
Gilt für:
BeginExecuteXmlReader(AsyncCallback, Object)
Initiiert die asynchrone Ausführung der Transact-SQL-Anweisung oder der gespeicherten Prozedur, die von diesem SqlCommand beschrieben wird, und gibt mithilfe einer Rückrufprozedur die Ergebnisse in Form eines XmlReader-Objekts zurück.
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
Ein AsyncCallback-Delegat, der aufgerufen wird, wenn die Ausführung des Befehls abgeschlossen wurde. Übergeben Sie null (Nothing in Microsoft Visual Basic), um anzugeben, dass kein Rückruf erforderlich ist.
- stateObject
- Object
Ein benutzerdefiniertes Zustandsobjekt, das an die Rückrufprozedur übergeben wird. Rufen Sie dieses Objekt innerhalb der Rückrufprozedur mit der AsyncState-Eigenschaft ab.
Gibt zurück
Ein IAsyncResult, das zum Abfragen von Ergebnissen und/oder als Warteschleife verwendet werden kann. Dieser Wert wird auch benötigt, wenn EndExecuteXmlReader(IAsyncResult) aufgerufen wird, mit dem die Ergebnisse des Befehls im XML-Format zurückgegeben werden.
Ausnahmen
Es wurde ein anderer SqlDbType als Binary oder VarBinary verwendet, als Value auf Stream festgelegt wurde. Weitere Informationen zum Streaming finden Sie unter SqlClient Streaming Support (SqlClient-Streamingunterstützung).
- oder -
Ein SqlDbType anderes als Char, NChar, NVarChar, VarChar oder Xml wurde verwendet, wenn Value auf TextReaderfestgelegt wurde.
- oder -
Es wurde ein anderer SqlDbType als Xml verwendet, als Value auf XmlReader festgelegt wurde.
Alle Fehler, die beim Ausführen des Befehlstexts aufgetreten sind.
- oder -
Bei einem Streamingvorgang ist ein Timeout aufgetreten. Weitere Informationen zum Streaming finden Sie unter SqlClient Streaming Support (SqlClient-Streamingunterstützung).
Das Name-Wert-Paar "Asynchronous Processing=true" war nicht in der Verbindungszeichenfolge enthalten, mit der die Verbindung für diesen SqlCommand definiert wird.
- oder -
Die SqlConnection wurde während eines Streamingvorgangs geschlossen oder getrennt. Weitere Informationen zum Streaming finden Sie unter SqlClient Streaming Support (SqlClient-Streamingunterstützung).
Während eines Streamingvorgangs ist bei einem Stream-, XmlReader- oder TextReader-Objekt ein Fehler aufgetreten. Weitere Informationen zum Streaming finden Sie unter SqlClient Streaming Support (SqlClient-Streamingunterstützung).
Das Stream-, XmlReader- oder TextReader-Objekt wurde während eines Streamingvorgangs geschlossen. Weitere Informationen zum Streaming finden Sie unter SqlClient Streaming Support (SqlClient-Streamingunterstützung).
Beispiele
Die folgende Windows-Anwendung veranschaulicht die Verwendung der BeginExecuteXmlReader-Methode, bei der (zum Emulieren eines Befehls mit langer Ausführungszeit) eine Transact-SQL-Anweisung mit einer Verzögerung von einigen Sekunden ausgeführt wird. In diesem Beispiel wird das ausführende SqlCommand Objekt als stateObject Parameter übergeben. Dadurch ist es einfach, das Objekt aus der SqlCommand Rückrufprozedur abzurufen, sodass der Code die EndExecuteXmlReader -Methode aufrufen kann, die dem anfänglichen Aufruf BeginExecuteXmlReadervon entspricht.
In diesem Beispiel werden viele wichtige Techniken veranschaulicht. Dies schließt den Aufruf einer Methode ein, die mit dem Formular aus einem separaten Thread interagiert. Darüber hinaus veranschaulicht dieses Beispiel, wie Sie verhindern müssen, dass Benutzer einen Befehl mehrmals gleichzeitig ausführen, und wie Sie sicherstellen müssen, dass das Formular nicht geschlossen wird, bevor die Rückrufprozedur aufgerufen wird.
Um dieses Beispiel einzurichten, erstellen Sie eine neue Windows-Anwendung. Fügen Sie ein Button Steuerelement, ein ListBox Steuerelement und ein Label Steuerelement auf das Formular ein (wobei der Standardname für jedes Steuerelement akzeptiert wird). Fügen Sie der Klasse des Formulars den folgenden Code hinzu, und ändern Sie die Verbindungszeichenfolge nach Bedarf für Ihre Umgebung.
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
Hinweise
Die BeginExecuteXmlReader -Methode startet den Prozess der asynchronen Ausführung einer Transact-SQL-Anweisung oder einer gespeicherten Prozedur, die Zeilen als XML zurückgibt, sodass andere Aufgaben gleichzeitig ausgeführt werden können, während die Anweisung ausgeführt wird. Wenn die Anweisung abgeschlossen ist, müssen Entwickler die EndExecuteXmlReader -Methode aufrufen, um den Vorgang abzuschließen und die angeforderten XML-Daten abzurufen. Die BeginExecuteXmlReader -Methode gibt sofort zurück, aber bis der Code den entsprechenden EndExecuteXmlReader Methodenaufruf ausführt, darf sie keine anderen Aufrufe ausführen, die eine synchrone oder asynchrone Ausführung für dasselbe SqlCommand Objekt starten. Wenn Sie die EndExecuteXmlReader aufrufen, bevor die Ausführung des Befehls abgeschlossen ist, wird das SqlCommand Objekt blockiert, bis die Ausführung abgeschlossen ist.
Die CommandText -Eigenschaft gibt normalerweise eine Transact-SQL-Anweisung mit einer gültigen FOR XML-Klausel an. Kann jedoch auch eine -Anweisung angeben, CommandText die Daten zurückgibt, die gültiges XML enthalten. Diese Methode kann auch verwendet werden, um ein einspaltiges Resultset abzurufen. Wenn in diesem Fall mehr als eine Zeile zurückgegeben wird, fügt die EndExecuteXmlReader -Methode an XmlReader den Wert in der ersten Zeile an und verwirft den Rest des Resultsets.
Eine typische BeginExecuteXmlReader Abfrage kann wie im folgenden C#-Beispiel formatiert werden:
SqlCommand command = new SqlCommand("SELECT ContactID, FirstName, LastName FROM Contact FOR XML AUTO, XMLDATA", SqlConn);
Diese Methode kann auch verwendet werden, um ein einspaltiges Resultset abzurufen. Wenn in diesem Fall mehr als eine Zeile zurückgegeben wird, fügt die EndExecuteXmlReader -Methode an XmlReader den Wert in der ersten Zeile an und verwirft den Rest des Resultsets.
Mit der Mars-Funktion (Multiple Active Result Set) können mehrere Aktionen dieselbe Verbindung verwenden.
Mit callback dem -Parameter können Sie einen AsyncCallback Delegaten angeben, der aufgerufen wird, wenn die Anweisung abgeschlossen ist. Sie können die EndExecuteXmlReader -Methode innerhalb dieser Delegatprozedur oder von einem beliebigen anderen Speicherort in Ihrer Anwendung aufrufen. Darüber hinaus können Sie jedes Objekt im stateObject Parameter übergeben, und Ihre Rückrufprozedur kann diese Informationen mithilfe der AsyncState -Eigenschaft abrufen.
Beachten Sie, dass der Befehlstext und die Parameter synchron an den Server gesendet werden. Wenn ein großer Befehl oder viele Parameter gesendet werden, kann diese Methode während Schreibvorgängen blockiert werden. Nachdem der Befehl gesendet wurde, gibt die Methode sofort zurück, ohne auf eine Antwort vom Server zu warten, d. h. Lesevorgänge sind asynchron.
Alle Fehler, die während der Ausführung des Vorgangs auftreten, werden in der Rückrufprozedur als Ausnahmen ausgelöst. Sie müssen die Ausnahme in der Rückrufprozedur behandeln, nicht in der Standard-Anwendung. Weitere Informationen zur Behandlung von Ausnahmen in der Rückrufprozedur finden Sie im Beispiel in diesem Thema.
Wenn Sie XML-Daten verwenden ExecuteReader oder BeginExecuteReader darauf zugreifen, gibt SQL Server xml-Ergebnisse mit einer Länge von mehr als 2.033 Zeichen in mehreren Zeilen mit jeweils 2.033 Zeichen zurück. Verwenden Oder BeginExecuteXmlReader lesen Sie FOR XML-Abfragen, ExecuteXmlReader um dieses Verhalten zu vermeiden.
Diese Methode ignoriert die CommandTimeout -Eigenschaft.
