SqlCommand.ExecuteXmlReader メソッド

定義

名前空間:

Microsoft.Data.SqlClient

アセンブリ:

Microsoft.Data.SqlClient.dll

パッケージ:

Microsoft.Data.SqlClient v5.2.0

CommandText を Connection に送信し、XmlReader オブジェクトを構築します。

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

public System.Xml.XmlReader ExecuteXmlReader ();

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

Public Function ExecuteXmlReader () As XmlReader

戻り値

XmlReader

XmlReader オブジェクト。

例外

InvalidCastException

SqlDbTypeが にStream設定されている場合Valueは、Binary または VarBinary 以外の が使用されました。 ストリーミングの詳細については、「SqlClient ストリーミング サポート」を参照してください。

- または -

SqlDbTypeが にTextReader設定されている場合Value、Char、NChar、NVarChar、VarChar、または Xml 以外の が使用されました。

または

SqlDbTypeが にXmlReader設定されたときに Xml 以外の がValue使用されました。

SqlException

ロックされた行に対するコマンドの実行中に、例外が発生しました。 Microsoft .NET Framework バージョン 1.0 を使用している場合は、この例外は生成されません。

- または -

ストリーミング操作中にタイムアウトが発生しました。 ストリーミングの詳細については、「SqlClient ストリーミング サポート」を参照してください。

InvalidOperationException

ストリーミング操作中に、SqlConnection が閉じられたか切断されました。 ストリーミングの詳細については、「SqlClient ストリーミング サポート」を参照してください。

IOException

ストリーミング操作中に、 Stream オブジェクト XmlReader または TextReader オブジェクトでエラーが発生しました。 ストリーミングの詳細については、「SqlClient ストリーミング サポート」を参照してください。

ObjectDisposedException

XmlReader、または TextReader オブジェクトはStream、ストリーミング操作中に閉じられました。 ストリーミングの詳細については、「SqlClient ストリーミング サポート」を参照してください。

例

次の例では、 を SqlCommand 作成し、 を使用して ExecuteXmlReader実行します。 この例では、Transact-SQL FOR XML SELECT ステートメントである文字列と、データ ソースへの接続に使用する文字列が渡されます。

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();
    }
}

注釈

このメソッドによって返される XmlReader は、非同期操作をサポートしていません。 プロパティは CommandText 通常、有効な FOR XML 句を持つ Transact-SQL ステートメントを指定します。 ただし、CommandText有効な XML を含む または nvarchar データを返すntextステートメント、またはデータ型で定義された列の内容をxml指定することもできます。

一般的なExecuteXmlReaderクエリは、Microsoft Visual C# の例を次のように書式設定できます。

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

このメソッドを使用して、XML データを含む単一行の単一列の結果セットを取得することもできます。 この場合、複数の行が返された場合、 ExecuteXmlReader メソッドは 最初の行の値に をアタッチ XmlReader し、結果セットの残りの部分を破棄します。

複数のアクティブな結果セット (MARS) 機能を使用すると、同じ接続を使用して複数のアクションを実行できます。

または BeginExecuteReader を使用ExecuteReaderして XML データにアクセスする場合、SQL Serverは、それぞれ 2,033 文字の複数行で 2,033 文字を超える XML 結果を返します。 この動作を回避するには、 または BeginExecuteXmlReader を使用ExecuteXmlReaderして FOR XML クエリを読み取ります。