SqlCommand.BeginExecuteXmlReader Méthode
Définition
Important
Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.
Surcharges
| BeginExecuteXmlReader() |
Lance l’exécution asynchrone de l’instruction Transact-SQL ou de la procédure stockée décrite par ce SqlCommand et retourne les résultats sous forme d’objet XmlReader. |
| BeginExecuteXmlReader(AsyncCallback, Object) |
Lance l’exécution asynchrone de l’instruction Transact-SQL ou de la procédure stockée qui est décrite par cet SqlCommand et retourne les résultats en tant qu’objet XmlReader à l’aide d’une procédure de rappel. |
BeginExecuteXmlReader()
Lance l’exécution asynchrone de l’instruction Transact-SQL ou de la procédure stockée décrite par ce SqlCommand et retourne les résultats sous forme d’objet XmlReader.
public:
IAsyncResult ^ BeginExecuteXmlReader();public IAsyncResult BeginExecuteXmlReader ();member this.BeginExecuteXmlReader : unit -> IAsyncResultPublic Function BeginExecuteXmlReader () As IAsyncResultRetours
IAsyncResult qui peut être utilisé pour interroger ou attendre les résultats, ou les deux ; cette valeur est également nécessaire lors de l’appelEndExecuteXmlReader , qui retourne une seule valeur XML.
Exceptions
Un SqlDbType autre que Binary ou VarBinary a été utilisé lorsque Value a été défini sur Stream . Pour plus d’informations sur le streaming, consultez Prise en charge du streaming pour SqlClient.
- ou -
Un SqlDbType autre que Char, NChar, NVarChar, VarChar ou Xml a été utilisé quand Value a été défini sur TextReader .
-ou-
Un SqlDbType autre que Xml a été utilisé lorsque Value a été défini sur XmlReader .
Toute erreur qui s’est produite pendant l’exécution du texte de la commande.
- ou -
Un délai d’attente a été dépassé pendant une opération de diffusion en continu. Pour plus d’informations sur le streaming, consultez Prise en charge du streaming pour SqlClient.
La SqlConnection a été fermée ou supprimée pendant une opération de diffusion en continu. Pour plus d’informations sur le streaming, consultez Prise en charge du streaming pour 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.
Une erreur s’est produite dans un Stream objet ou XmlReaderTextReader pendant une opération de diffusion en continu. Pour plus d’informations sur le streaming, consultez Prise en charge du streaming pour SqlClient.
L’objet Stream ou XmlReaderTextReader a été fermé pendant une opération de diffusion en continu. Pour plus d’informations sur le streaming, consultez Prise en charge du streaming pour SqlClient.
Exemples
L’application console suivante démarre le processus de récupération des données XML de manière asynchrone. En attendant les résultats, cette application simple se trouve dans une boucle, examinant la valeur de la IsCompleted propriété. Une fois le processus terminé, le code récupère le code XML et affiche son contenu.
[!code-csharp[SqlCommand_BeginExecuteXmlReader#1]((~/.. /sqlclient/doc/samples/SqlCommand_BeginExecuteXmlReader.cs)]
Remarques
La BeginExecuteXmlReader méthode démarre le processus d’exécution asynchrone d’une instruction Transact-SQL qui retourne des lignes au format XML, afin que d’autres tâches puissent s’exécuter simultanément pendant l’exécution de l’instruction. Une fois l’instruction terminée, les développeurs doivent appeler la EndExecuteXmlReader méthode pour terminer l’opération et récupérer le code XML retourné par la commande. La BeginExecuteXmlReader méthode retourne immédiatement, mais tant que le code n’exécute pas l’appel de méthode correspondant EndExecuteXmlReader , elle ne doit pas exécuter d’autres appels qui démarrent une exécution synchrone ou asynchrone sur le même SqlCommand objet. L’appel du EndExecuteXmlReader avant la fin de l’exécution de la commande entraîne le blocage de l’objet SqlCommand jusqu’à ce que l’exécution soit terminée.
La CommandText propriété spécifie normalement une instruction Transact-SQL avec une clause FOR XML valide. Toutefois, CommandText peut également spécifier une instruction qui retourne ntext des données qui contiennent du code XML valide.
Une requête classique BeginExecuteXmlReader peut être mise en forme comme dans l’exemple C# suivant :
SqlCommand command = new SqlCommand("SELECT ContactID, FirstName, LastName FROM dbo.Contact FOR XML AUTO, XMLDATA", SqlConn);
Cette méthode peut également être utilisée pour récupérer un jeu de résultats à une seule ligne et à colonne unique. Dans ce cas, si plusieurs lignes sont retournées, la EndExecuteXmlReader méthode attache le XmlReader à la valeur de la première ligne et ignore le reste du jeu de résultats.
La fonctionnalité mars (multiple active result set) permet à plusieurs actions d’utiliser la même connexion.
Notez que le texte et les paramètres de la commande sont envoyés au serveur de manière synchrone. Si une commande volumineuse ou de nombreux paramètres sont envoyés, cette méthode peut se bloquer pendant les écritures. Une fois la commande envoyée, la méthode retourne immédiatement sans attendre la réponse du serveur. Autrement dit, les lectures sont asynchrones. Bien que l’exécution des commandes soit asynchrone, l’extraction de valeur est toujours synchrone.
Étant donné que cette surcharge ne prend pas en charge une procédure de rappel, les développeurs doivent interroger pour déterminer si la commande est terminée, à l’aide de la IsCompleted propriété du IAsyncResult retourné par la BeginExecuteXmlReader méthode ; ou attendre l’achèvement d’une ou plusieurs commandes à l’aide de la AsyncWaitHandle propriété du retourné IAsyncResult.
Si vous utilisez ExecuteReader ou BeginExecuteReader pour accéder à des données XML, SQL Server retourne les résultats XML d’une longueur supérieure à 2 033 caractères dans plusieurs lignes de 2 033 caractères chacune. Pour éviter ce comportement, utilisez ExecuteXmlReader ou BeginExecuteXmlReader pour lire des requêtes FOR XML.
Cette méthode ignore la CommandTimeout propriété .
S’applique à
BeginExecuteXmlReader(AsyncCallback, Object)
Lance l’exécution asynchrone de l’instruction Transact-SQL ou de la procédure stockée qui est décrite par cet SqlCommand et retourne les résultats en tant qu’objet XmlReader à l’aide d’une procédure de rappel.
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 IAsyncResultParamètres
- callback
- AsyncCallback
Délégué AsyncCallback qui est appelé une fois l’exécution de la commande terminée. Réussitenull ( Nothing dans Microsoft Visual Basic) pour indiquer qu’aucun rappel n’est requis.
- stateObject
- Object
Objet d'état défini par l'utilisateur qui est transmis à la procédure de rappel. Récupérez cet objet à partir de la procédure de rappel à l’aide de la propriété AsyncState.
Retours
Un IAsyncResult qui peut être utilisé pour interroger ou attendre les résultats, ou bien les deux ; cette valeur est également requise quand le EndExecuteXmlReader(IAsyncResult) est appelé, ce qui retourne les résultats de la commande en tant que XML.
Exceptions
Un SqlDbType autre que Binary ou VarBinary a été utilisé lorsque Value a été défini sur Stream . Pour plus d’informations sur le streaming, consultez Prise en charge du streaming pour SqlClient.
- ou -
Un SqlDbType autre que Char, NChar, NVarChar, VarChar ou Xml a été utilisé quand Value a été défini sur TextReader .
-ou-
Un SqlDbType autre que Xml a été utilisé lorsque Value a été défini sur XmlReader .
Toute erreur qui s’est produite pendant l’exécution du texte de la commande.
- ou -
Un délai d’attente a été dépassé pendant une opération de diffusion en continu. Pour plus d’informations sur le streaming, consultez Prise en charge du streaming pour SqlClient.
La SqlConnection a été fermée ou supprimée pendant une opération de diffusion en continu. Pour plus d’informations sur le streaming, consultez Prise en charge du streaming pour 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.
Une erreur s’est produite dans un Stream objet ou XmlReaderTextReader pendant une opération de diffusion en continu. Pour plus d’informations sur le streaming, consultez Prise en charge du streaming pour SqlClient.
L’objet Stream ou XmlReaderTextReader a été fermé pendant une opération de diffusion en continu. Pour plus d’informations sur le streaming, consultez Prise en charge du streaming pour SqlClient.
Exemples
L’application Windows suivante illustre l’utilisation de la méthode BeginExecuteXmlReader, en exécutant une instruction Transact-SQL qui comprend un délai de quelques secondes (en émulant une commande longue). Cet exemple montre comment faire passer l’objet en cours d’exécution SqlCommand en tant que stateObject paramètre. Il est donc facile de récupérer l’objet SqlCommand à partir de la procédure de rappel, afin que le code puisse appeler la EndExecuteXmlReader méthode correspondant à l’appel initial à BeginExecuteXmlReader.
Cet exemple illustre de nombreuses techniques importantes. Cela inclut l’appel d’une méthode qui interagit avec le formulaire à partir d’un thread distinct. En outre, cet exemple montre comment vous devez empêcher les utilisateurs d’exécuter une commande plusieurs fois simultanément et comment vous devez vous assurer que le formulaire ne se ferme pas avant l’appel de la procédure de rappel.
Pour configurer cet exemple, créez une nouvelle application Windows. Placez un Button contrôle, un ListBox contrôle et un Label contrôle sur le formulaire (en acceptant le nom par défaut de chaque contrôle). Ajoutez le code suivant à la classe du formulaire, en modifiant la chaîne de connexion en fonction des besoins de votre environnement.
// <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>
Remarques
La BeginExecuteXmlReader méthode démarre le processus d’exécution asynchrone d’une instruction Transact-SQL ou d’une procédure stockée qui retourne des lignes au format XML, afin que d’autres tâches puissent s’exécuter simultanément pendant l’exécution de l’instruction. Une fois l’instruction terminée, les développeurs doivent appeler la EndExecuteXmlReader méthode pour terminer l’opération et récupérer les données XML demandées. La BeginExecuteXmlReader méthode retourne immédiatement, mais tant que le code n’exécute pas l’appel de méthode correspondant EndExecuteXmlReader , elle ne doit pas exécuter d’autres appels qui démarrent une exécution synchrone ou asynchrone sur le même SqlCommand objet. L’appel du EndExecuteXmlReader avant la fin de l’exécution de la commande entraîne le blocage de l’objet SqlCommand jusqu’à ce que l’exécution soit terminée.
La CommandText propriété spécifie normalement une instruction Transact-SQL avec une clause FOR XML valide. Toutefois, CommandText peut également spécifier une instruction qui retourne des données qui contiennent du code XML valide. Cette méthode peut également être utilisée pour récupérer un jeu de résultats à une seule ligne et à colonne unique. Dans ce cas, si plusieurs lignes sont retournées, la EndExecuteXmlReader méthode attache le XmlReader à la valeur de la première ligne et ignore le reste du jeu de résultats.
Une requête classique BeginExecuteXmlReader peut être mise en forme comme dans l’exemple C# suivant :
SqlCommand command = new SqlCommand("SELECT ContactID, FirstName, LastName FROM Contact FOR XML AUTO, XMLDATA", SqlConn);
Cette méthode peut également être utilisée pour récupérer un jeu de résultats à une seule ligne et à colonne unique. Dans ce cas, si plusieurs lignes sont retournées, la EndExecuteXmlReader méthode attache le XmlReader à la valeur de la première ligne et ignore le reste du jeu de résultats.
La fonctionnalité mars (multiple active result set) permet à plusieurs actions d’utiliser la même connexion.
Le callback paramètre vous permet de spécifier un AsyncCallback délégué appelé une fois l’instruction terminée. Vous pouvez appeler la EndExecuteXmlReader méthode à partir de cette procédure déléguée ou de n’importe quel autre emplacement au sein de votre application. En outre, vous pouvez passer n’importe quel objet dans le stateObject paramètre, et votre procédure de rappel peut récupérer ces informations à l’aide de la AsyncState propriété .
Notez que le texte et les paramètres de la commande sont envoyés au serveur de manière synchrone. Si une commande volumineuse ou de nombreux paramètres est envoyé, cette méthode peut bloquer pendant les écritures. Une fois la commande envoyée, la méthode retourne immédiatement sans attendre la réponse du serveur. Autrement dit, les lectures sont asynchrones.
Toutes les erreurs qui se produisent pendant l’exécution de l’opération sont levées en tant qu’exceptions dans la procédure de rappel. Vous devez gérer l’exception dans la procédure de rappel, et non dans l’application principale. Pour plus d’informations sur la gestion des exceptions dans la procédure de rappel, consultez l’exemple de cette rubrique.
Si vous utilisez ExecuteReader ou BeginExecuteReader pour accéder à des données XML, SQL Server retourne les résultats XML d’une longueur supérieure à 2 033 caractères dans plusieurs lignes de 2 033 caractères chacune. Pour éviter ce comportement, utilisez ExecuteXmlReader ou BeginExecuteXmlReader pour lire des requêtes FOR XML.
Cette méthode ignore la CommandTimeout propriété .