SqlCommand.BeginExecuteXmlReader Metodo
Definizione
Importante
Alcune informazioni sono relative alla release non definitiva del prodotto, che potrebbe subire modifiche significative prima della release definitiva. Microsoft non riconosce alcuna garanzia, espressa o implicita, in merito alle informazioni qui fornite.
Overload
| BeginExecuteXmlReader() |
Avvia l'esecuzione asincrona dell'istruzione Transact-SQL o della stored procedure descritta dall'oggetto SqlCommand e restituisce i risultati come oggetto XmlReader. |
| BeginExecuteXmlReader(AsyncCallback, Object) |
Avvia l'esecuzione asincrona dell'istruzione Transact-SQL o della stored procedure descritta dall'oggetto SqlCommand e restituisce i risultati come oggetto XmlReader usando una routine di callback. |
BeginExecuteXmlReader()
Avvia l'esecuzione asincrona dell'istruzione Transact-SQL o della stored procedure descritta dall'oggetto SqlCommand e restituisce i risultati come oggetto XmlReader.
public:
IAsyncResult ^ BeginExecuteXmlReader();public IAsyncResult BeginExecuteXmlReader ();member this.BeginExecuteXmlReader : unit -> IAsyncResultPublic Function BeginExecuteXmlReader () As IAsyncResultRestituisce
Oggetto IAsyncResult che può essere utilizzato per eseguire il polling o attendere i risultati o entrambi. Questo valore è necessario anche quando si richiamaEndExecuteXmlReader , che restituisce un singolo valore XML.
Eccezioni
Un SqlDbType oggetto diverso da Binary o VarBinary è stato usato quando Value è stato impostato su Stream . Per altre informazioni sul flusso, vedere Supporto del flusso SqlClient.
-oppure-
Un SqlDbType oggetto diverso da Char, NChar, NVarChar, VarChar o Xml è stato usato quando Value è stato impostato su TextReader .
-oppure-
È SqlDbType stato utilizzato un valore diverso da Xml quando Value è stato impostato su XmlReader .
Qualsiasi errore che si è verificato durante l'esecuzione del testo del comando.
-oppure-
Si è verificato un timeout durante un'operazione di flusso. Per altre informazioni sul flusso, vedere Supporto del flusso SqlClient.
L'elemento SqlConnection chiuso o eliminato durante l'operazione di flusso. Per altre informazioni sul flusso, vedere Supporto del flusso SqlClient.
- or -
<xref data-throw-if-not-resolved="true" uid="Microssoft.Data.SqlClient.SqlCommand.EnableOptimizedParameterBinding"></xref>
is set to true and a parameter with direction Output or InputOutput has been added to the <xref data-throw-if-not-resolved="true" uid="Microsoft.Data.SqlClient.SqlCommand.Parameters"></xref> collection.
Si è verificato un errore in un Stream oggetto o XmlReaderTextReader durante un'operazione di streaming. Per altre informazioni sul flusso, vedere Supporto del flusso SqlClient.
L'oggetto Stream o XmlReaderTextReader è stato chiuso durante un'operazione di streaming. Per altre informazioni sul flusso, vedere Supporto del flusso SqlClient.
Esempio
L'applicazione console seguente avvia il processo di recupero asincrono dei dati XML. Durante l'attesa dei risultati, questa semplice applicazione si trova in un ciclo, analizzando il valore della IsCompleted proprietà. Al termine del processo, il codice recupera il codice XML e ne visualizza il contenuto.
[!code-csharp[SqlCommand_BeginExecuteXmlReader#1]((~/.. /sqlclient/doc/samples/SqlCommand_BeginExecuteXmlReader.cs)]
Commenti
Il BeginExecuteXmlReader metodo avvia il processo di esecuzione asincrona di un'istruzione Transact-SQL che restituisce righe come XML, in modo che altre attività possano essere eseguite simultaneamente durante l'esecuzione dell'istruzione. Al termine dell'istruzione, gli sviluppatori devono chiamare il EndExecuteXmlReader metodo per completare l'operazione e recuperare il codice XML restituito dal comando . Il BeginExecuteXmlReader metodo restituisce immediatamente, ma finché il codice non esegue la chiamata al metodo corrispondente EndExecuteXmlReader , non deve eseguire altre chiamate che avviano un'esecuzione sincrona o asincrona sullo stesso SqlCommand oggetto. EndExecuteXmlReader La chiamata a prima del completamento dell'esecuzione del comando determina il blocco dell'oggetto SqlCommand fino al termine dell'esecuzione.
La CommandText proprietà specifica in genere un'istruzione Transact-SQL con una clausola FOR XML valida. Tuttavia, CommandText può anche specificare un'istruzione che restituisce ntext dati che contengono dati XML validi.
Una query tipica BeginExecuteXmlReader può essere formattata come nell'esempio C# seguente:
SqlCommand command = new SqlCommand("SELECT ContactID, FirstName, LastName FROM dbo.Contact FOR XML AUTO, XMLDATA", SqlConn);
Questo metodo può essere usato anche per recuperare un set di risultati a riga singola e a colonna singola. In questo caso, se vengono restituite più righe, il EndExecuteXmlReader metodo associa l'oggetto XmlReader al valore nella prima riga e rimuove il resto del set di risultati.
La funzionalità mars (Multiple Active Result Set) consente a più azioni di usare la stessa connessione.
Si noti che il testo e i parametri del comando vengono inviati al server in modo sincrono. Se viene inviato un comando di grandi dimensioni o molti parametri, questo metodo può bloccarsi durante le scritture. Dopo l'invio del comando, il metodo restituisce immediatamente senza attendere una risposta dal server, ovvero le letture sono asincrone. Anche se l'esecuzione dei comandi è asincrona, il recupero del valore è ancora sincrono.
Poiché questo overload non supporta una routine di callback, gli sviluppatori devono eseguire il polling per determinare se il comando è stato completato, usando la proprietà dell'oggetto IAsyncResult restituito dal BeginExecuteXmlReader metodo oppure attendere il completamento di uno o più comandi usando la AsyncWaitHandle proprietà dell'oggetto restituitoIAsyncResult.IsCompleted
Se si utilizza ExecuteReader o BeginExecuteReader per accedere ai dati XML, SQL Server restituisce risultati XML maggiori di 2.033 caratteri di lunghezza in più righe di 2.033 caratteri ciascuno. Per evitare questo comportamento, utilizzare ExecuteXmlReader o BeginExecuteXmlReader per leggere le query FOR XML.
Questo metodo ignora la CommandTimeout proprietà .
Si applica a
BeginExecuteXmlReader(AsyncCallback, Object)
Avvia l'esecuzione asincrona dell'istruzione Transact-SQL o della stored procedure descritta dall'oggetto SqlCommand e restituisce i risultati come oggetto XmlReader usando una routine di callback.
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 IAsyncResultParametri
- callback
- AsyncCallback
Delegato AsyncCallback richiamato al termine dell'esecuzione del comando. Passnull ( Nothing in Microsoft Visual Basic) per indicare che non è necessario alcun callback.
- stateObject
- Object
Oggetto di stato definito dall'utente e passato alla routine di callback. Recuperare questo oggetto dalla routine di callback usando la proprietà AsyncState.
Restituisce
Oggetto IAsyncResult che può essere usato per eseguire il polling, attendere i risultati o entrambe le cose. Questo valore è necessario anche per chiamare il metodo EndExecuteXmlReader(IAsyncResult), che restituisce i risultati del comando come dati XML.
Eccezioni
Un SqlDbType oggetto diverso da Binary o VarBinary è stato usato quando Value è stato impostato su Stream . Per altre informazioni sul flusso, vedere Supporto del flusso SqlClient.
-oppure-
Un SqlDbType oggetto diverso da Char, NChar, NVarChar, VarChar o Xml è stato usato quando Value è stato impostato su TextReader .
-oppure-
È SqlDbType stato utilizzato un valore diverso da Xml quando Value è stato impostato su XmlReader .
Qualsiasi errore che si è verificato durante l'esecuzione del testo del comando.
-oppure-
Si è verificato un timeout durante un'operazione di flusso. Per altre informazioni sul flusso, vedere Supporto del flusso SqlClient.
L'elemento SqlConnection chiuso o eliminato durante l'operazione di flusso. Per altre informazioni sul flusso, vedere Supporto del flusso SqlClient.
- or -
<xref data-throw-if-not-resolved="true" uid="Microssoft.Data.SqlClient.SqlCommand.EnableOptimizedParameterBinding"></xref>
is set to true and a parameter with direction Output or InputOutput has been added to the <xref data-throw-if-not-resolved="true" uid="Microsoft.Data.SqlClient.SqlCommand.Parameters"></xref> collection.
Si è verificato un errore in un Stream oggetto o XmlReaderTextReader durante un'operazione di streaming. Per altre informazioni sul flusso, vedere Supporto del flusso SqlClient.
L'oggetto Stream o XmlReaderTextReader è stato chiuso durante un'operazione di streaming. Per altre informazioni sul flusso, vedere Supporto del flusso SqlClient.
Esempio
Nell'applicazione Windows seguente viene illustrato l'uso del metodo BeginExecuteXmlReader, eseguendo un'istruzione Transact-SQL che include un ritardo di pochi secondi (emulando un comando con esecuzione prolungata). In questo esempio l'oggetto in esecuzione SqlCommand viene passato come stateObject parametro, in modo da semplificare il recupero dell'oggetto SqlCommand dall'interno della routine di callback, in modo che il codice possa chiamare il EndExecuteXmlReader metodo corrispondente alla chiamata iniziale a BeginExecuteXmlReader.
In questo esempio vengono illustrate molte tecniche importanti. Ciò include la chiamata di un metodo che interagisce con il form da un thread separato. In questo esempio viene inoltre illustrato come impedire agli utenti di eseguire più volte un comando contemporaneamente e come assicurarsi che il modulo non venga chiuso prima che venga chiamata la routine di callback.
Per impostare questo esempio, creare una nuova applicazione Windows. Inserire un Button controllo, un ListBox controllo e un Label controllo nel form (accettando il nome predefinito per ogni controllo). Aggiungere il codice seguente alla classe del modulo, modificando la stringa di connessione in base alle esigenze dell'ambiente.
// <Snippet1>
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Text;
using System.Windows.Forms;
using Microsoft.Data.SqlClient;
using System.Xml;
namespace 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.
return "Data Source=(local);Integrated Security=true;" +
"Initial Catalog=AdventureWorks";
}
private void DisplayStatus(string Text)
{
this.label1.Text = Text;
}
private void ClearProductInfo()
{
// Clear the list box.
this.listBox1.Items.Clear();
}
private void DisplayProductInfo(XmlReader reader)
{
// Display the data within the reader.
while (reader.Read())
{
// Skip past items that are not from the correct table.
if (reader.LocalName.ToString() == "Production.Product")
{
this.listBox1.Items.Add(String.Format("{0}: {1:C}",
reader["Name"], Convert.ToDecimal(reader["ListPrice"])));
}
}
DisplayStatus("Ready");
}
private void Form1_FormClosing(object sender,
System.Windows.Forms.FormClosingEventArgs e)
{
if (isExecuting)
{
MessageBox.Show(this, "Cannot close the form until " +
"the pending asynchronous command has completed. Please wait...");
e.Cancel = true;
}
}
private void button1_Click(object sender, System.EventArgs e)
{
if (isExecuting)
{
MessageBox.Show(this,
"Already executing. Please wait until the current query " +
"has completed.");
}
else
{
SqlCommand command = null;
try
{
ClearProductInfo();
DisplayStatus("Connecting...");
connection = new SqlConnection(GetConnectionString());
// To emulate a long-running query, wait for
// a few seconds before working with the data.
string commandText =
"WAITFOR DELAY '00:00:03';" +
"SELECT Name, ListPrice FROM Production.Product " +
"WHERE ListPrice < 100 " +
"FOR XML AUTO, XMLDATA";
command = new SqlCommand(commandText, connection);
connection.Open();
DisplayStatus("Executing...");
isExecuting = true;
// Although it is not required that you pass the
// SqlCommand object as the second parameter in the
// BeginExecuteXmlReader call, doing so makes it easier
// to call EndExecuteXmlReader in the callback procedure.
AsyncCallback callback = new AsyncCallback(HandleCallback);
command.BeginExecuteXmlReader(callback, command);
}
catch (Exception ex)
{
isExecuting = false;
DisplayStatus(string.Format("Ready (last error: {0})", ex.Message));
if (connection != null)
{
connection.Close();
}
}
}
}
private void HandleCallback(IAsyncResult result)
{
try
{
// Retrieve the original command object, passed
// to this procedure in the AsyncState property
// of the IAsyncResult parameter.
SqlCommand command = (SqlCommand)result.AsyncState;
XmlReader reader = command.EndExecuteXmlReader(result);
// You may not interact with the form and its contents
// from a different thread, and this callback procedure
// is all but guaranteed to be running from a different thread
// than the form.
// Instead, you must call the procedure from the form's thread.
// One simple way to accomplish this is to call the Invoke
// method of the form, which calls the delegate you supply
// from the form's thread.
DisplayReaderDelegate del = new DisplayReaderDelegate(DisplayProductInfo);
this.Invoke(del, reader);
}
catch (Exception ex)
{
// Because you are now running code in a separate thread,
// if you do not handle the exception here, none of your other
// code catches the exception. Because none of
// your code is on the call stack in this thread, there is nothing
// higher up the stack to catch the exception if you do not
// handle it here. You can either log the exception or
// invoke a delegate (as in the non-error case in this
// example) to display the error on the form. In no case
// can you simply display the error without executing a delegate
// as in the try block here.
// You can create the delegate instance as you
// invoke it, like this:
this.Invoke(new DisplayInfoDelegate(DisplayStatus),
String.Format("Ready(last error: {0}", ex.Message));
}
finally
{
isExecuting = false;
if (connection != null)
{
connection.Close();
}
}
}
private void Form1_Load(object sender, System.EventArgs e)
{
this.button1.Click += new System.EventHandler(this.button1_Click);
this.FormClosing += new System.Windows.Forms.
FormClosingEventHandler(this.Form1_FormClosing);
}
}
}
// </Snippet1>
Commenti
Il BeginExecuteXmlReader metodo avvia il processo di esecuzione asincrona di un'istruzione Transact-SQL o di una stored procedure che restituisce righe come XML, in modo che altre attività possano essere eseguite simultaneamente durante l'esecuzione dell'istruzione. Al termine dell'istruzione, gli sviluppatori devono chiamare il EndExecuteXmlReader metodo per completare l'operazione e recuperare i dati XML richiesti. Il BeginExecuteXmlReader metodo restituisce immediatamente, ma finché il codice non esegue la chiamata al metodo corrispondente EndExecuteXmlReader , non deve eseguire altre chiamate che avviano un'esecuzione sincrona o asincrona sullo stesso SqlCommand oggetto. EndExecuteXmlReader La chiamata a prima del completamento dell'esecuzione del comando determina il blocco dell'oggetto SqlCommand fino al termine dell'esecuzione.
La CommandText proprietà specifica in genere un'istruzione Transact-SQL con una clausola FOR XML valida. Tuttavia, CommandText può anche specificare un'istruzione che restituisce dati che contengono dati XML validi. Questo metodo può essere usato anche per recuperare un set di risultati a riga singola e a colonna singola. In questo caso, se vengono restituite più righe, il EndExecuteXmlReader metodo associa l'oggetto XmlReader al valore nella prima riga e rimuove il resto del set di risultati.
Una query tipica BeginExecuteXmlReader può essere formattata come nell'esempio C# seguente:
SqlCommand command = new SqlCommand("SELECT ContactID, FirstName, LastName FROM Contact FOR XML AUTO, XMLDATA", SqlConn);
Questo metodo può essere usato anche per recuperare un set di risultati a riga singola e a colonna singola. In questo caso, se vengono restituite più righe, il EndExecuteXmlReader metodo associa l'oggetto XmlReader al valore nella prima riga e rimuove il resto del set di risultati.
La funzionalità mars (Multiple Active Result Set) consente a più azioni di usare la stessa connessione.
Il callback parametro consente di specificare un AsyncCallback delegato che viene chiamato al termine dell'istruzione. È possibile chiamare il EndExecuteXmlReader metodo dall'interno di questa procedura delegato o da qualsiasi altra posizione all'interno dell'applicazione. Inoltre, è possibile passare qualsiasi oggetto nel stateObject parametro e la routine di callback può recuperare queste informazioni usando la AsyncState proprietà .
Si noti che il testo e i parametri del comando vengono inviati al server in modo sincrono. Se viene inviato un comando di grandi dimensioni o molti parametri, questo metodo può bloccarsi durante le scritture. Dopo l'invio del comando, il metodo restituisce immediatamente senza attendere una risposta dal server, ovvero le letture sono asincrone.
Tutti gli errori che si verificano durante l'esecuzione dell'operazione vengono generati come eccezioni nella routine di callback. È necessario gestire l'eccezione nella procedura di callback, non nell'applicazione principale. Per altre informazioni sulla gestione delle eccezioni nella procedura di callback, vedere l'esempio in questo argomento.
Se si utilizza ExecuteReader o BeginExecuteReader per accedere ai dati XML, SQL Server restituirà risultati XML maggiori di 2.033 caratteri in più righe di 2.033 caratteri ciascuno. Per evitare questo comportamento, utilizzare ExecuteXmlReader o BeginExecuteXmlReader per leggere le query FOR XML.
Questo metodo ignora la CommandTimeout proprietà .