SqlCommand.ExecuteXmlReader Método

Definición

Espacio de nombres:

Microsoft.Data.SqlClient

Ensamblado:

Microsoft.Data.SqlClient.dll

Paquete:

Microsoft.Data.SqlClient v5.2.0

Envía CommandText a Connection y crea un objeto XmlReader.

public:
 System::Xml::XmlReader ^ ExecuteXmlReader();

public System.Xml.XmlReader ExecuteXmlReader ();

member this.ExecuteXmlReader : unit -> System.Xml.XmlReader

Public Function ExecuteXmlReader () As XmlReader

Devoluciones

XmlReader

Objeto XmlReader.

Excepciones

InvalidCastException

Se usó un SqlDbType valor distinto de Binary o VarBinary cuando Value se estableció Stream en . Para obtener más información sobre el streaming, vea Compatibilidad de transmisión de datos de SqlClient.

o bien

Se usó un SqlDbType valor distinto de Char, NChar, NVarChar, VarChar o Xml cuando Value se estableció TextReader en .

O bien

Se usó un SqlDbType valor distinto de Xml cuando Value se estableció XmlReader en .

SqlException

Se produjo una excepción al ejecutar el comando contra una fila bloqueada. Esta excepción no se genera cuando se usa Microsoft .NET Framework versión 1.0.

o bien

Se agotó el tiempo de espera durante una operación de streaming. Para obtener más información sobre el streaming, vea Compatibilidad de transmisión de datos de SqlClient.

InvalidOperationException

La SqlConnection se cerró o se interrumpió durante una operación de streaming. Para obtener más información sobre el streaming, vea Compatibilidad de transmisión de datos de SqlClient.

IOException

Error en un Stream objeto , XmlReader o TextReader durante una operación de streaming. Para obtener más información sobre el streaming, vea Compatibilidad de transmisión de datos de SqlClient.

ObjectDisposedException

El Stream objeto , XmlReader o TextReader se cerró durante una operación de streaming. Para obtener más información sobre el streaming, vea Compatibilidad de transmisión de datos de SqlClient.

Ejemplos

En el ejemplo siguiente se crea y SqlCommand , a continuación, se ejecuta mediante ExecuteXmlReader. El ejemplo se pasa una cadena que es una instrucción SELECT de Transact-SQL FOR XML y una cadena que se va a usar para conectarse al origen de datos.

using System;
using System.Data;
using Microsoft.Data.SqlClient;

private static void CreateXMLReader(string queryString,
    string connectionString)
{
    using (SqlConnection connection = new SqlConnection(
               connectionString))
    {
        connection.Open();
        SqlCommand command = new SqlCommand(queryString, connection);
        System.Xml.XmlReader reader = command.ExecuteXmlReader();
    }
}

Comentarios

XmlReader devuelto por este método no admite operaciones asincrónicas. La CommandText propiedad normalmente especifica una instrucción Transact-SQL con una cláusula FOR XML válida. Sin embargo, CommandText también puede especificar una instrucción que devuelva ntext o nvarchar datos que contengan XML válidos o el contenido de una columna definida con el xml tipo de datos.

Se puede dar formato a una consulta típica ExecuteXmlReader como en el siguiente ejemplo de Microsoft Visual C#:

SqlCommand command = new SqlCommand("SELECT * FROM dbo.Customers FOR XML AUTO, XMLDATA", SqlConn);

Este método también se puede usar para recuperar un conjunto de resultados de una sola fila y una sola columna que contiene datos XML. En este caso, si se devuelve más de una fila, el ExecuteXmlReader método adjunta el XmlReader al valor de la primera fila y descarta el resto del conjunto de resultados.

La característica de conjunto de resultados activos múltiples (MARS) permite realizar varias acciones con la misma conexión.

Si usa ExecuteReader o BeginExecuteReader para acceder a datos XML, SQL Server devolverá resultados XML mayores de 2033 caracteres de longitud en varias filas de 2033 caracteres cada uno. Para evitar este comportamiento, use ExecuteXmlReader o BeginExecuteXmlReader para leer consultas FOR XML.