SqlCommand.ExecuteXmlReader メソッド

定義

CommandTextConnection に送信し、XmlReader オブジェクトを構築します。Sends the CommandText to the Connection and builds an XmlReader object.

public:
 System::Xml::XmlReader ^ ExecuteXmlReader();
public System.Xml.XmlReader ExecuteXmlReader ();
member this.ExecuteXmlReader : unit -> System.Xml.XmlReader
Public Function ExecuteXmlReader () As XmlReader

戻り値

XmlReader オブジェクト。An XmlReader object.

例外

SqlDbTypeに設定されたときに、 BinaryでもVarBinaryValue でもない Stream が使用されました。A SqlDbType other than Binary or VarBinary was used when Value was set to Stream. ストリーミングの詳細については、「SqlClient ストリーミング サポート」を参照してください。For more information about streaming, see SqlClient Streaming Support.

または-or-

SqlDbTypeに設定されたときに、 Char NChar NVarChar VarChar XmlValue のいずれでもない TextReader が使用されました。A SqlDbType other than Char, NChar, NVarChar, VarChar, or Xml was used when Value was set to TextReader.

または-or-

SqlDbTypeに設定されたときに、 XmlValue 以外の XmlReader が使用されました。A SqlDbType other than Xml was used when Value was set to XmlReader.

ロックされた行に対するコマンドの実行中に、例外が発生しました。An exception occurred while executing the command against a locked row. Microsoft .NET Framework バージョン 1.0 を使用している場合は、この例外は生成されません。This exception is not generated when you are using Microsoft .NET Framework version 1.0.

または-or-

ストリーミング操作中にタイムアウトが発生しました。A timeout occurred during a streaming operation. ストリーミングの詳細については、「SqlClient ストリーミング サポート」を参照してください。For more information about streaming, see SqlClient Streaming Support.

ストリーミング操作中に、SqlConnection が閉じられたか切断されました。The SqlConnection closed or dropped during a streaming operation. ストリーミングの詳細については、「SqlClient ストリーミング サポート」を参照してください。For more information about streaming, see SqlClient Streaming Support.

ストリーミング操作中に、StreamXmlReader、または TextReader オブジェクトでエラーが発生しました。An error occurred in a Stream, XmlReader or TextReader object during a streaming operation. ストリーミングの詳細については、「SqlClient ストリーミング サポート」を参照してください。For more information about streaming, see SqlClient Streaming Support.

ストリーミング操作中に、StreamXmlReader、または TextReader オブジェクトが閉じられました。The Stream, XmlReader or TextReader object was closed during a streaming operation. ストリーミングの詳細については、「SqlClient ストリーミング サポート」を参照してください。For more information about streaming, see SqlClient Streaming Support.

次の例では、SqlCommand を作成し、ExecuteXmlReaderを使用して実行します。The following example creates a SqlCommand and then executes it using ExecuteXmlReader. この例には、Transact-sql FOR XML SELECT ステートメントである文字列と、データソースへの接続に使用する文字列が渡されます。The example is passed a string that is a Transact-SQL FOR XML SELECT statement, and a string to use to connect to the data source.

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();
    }
}
Public Sub CreateXMLReader(ByVal queryString As String, _
    ByVal connectionString As String)

    Using connection As New SqlConnection(connectionString)
        connection.Open()

        Dim command As New SqlCommand(queryString, connection)
        Dim reader As System.Xml.XmlReader = command.ExecuteXmlReader
    End Using
End Sub

注釈

このメソッドによって返されるXmlReaderは、非同期操作をサポートしていません。The XmlReader returned by this method does not support asynchronous operations.

CommandText プロパティは、通常、有効な FOR XML 句を含む Transact-SQLTransact-SQL ステートメントを指定します。The CommandText property ordinarily specifies a Transact-SQLTransact-SQL statement with a valid FOR XML clause. ただし、CommandText では、有効な XML を含むデータ ntextnvarchar または xml データ型で定義された列の内容を返すステートメントを指定することもできます。However, CommandText can also specify a statement that returns ntext or nvarchar data that contains valid XML, or the contents of a column defined with the xml data type.

一般的なExecuteXmlReaderクエリは、Microsoft Visual C# の例を次のように書式設定できます。A typical ExecuteXmlReader query can be formatted as in the following Microsoft Visual C# example:

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

このメソッドを使用して、XML データを含む単一行の単一列の結果セットを取得することもできます。This method can also be used to retrieve a single-row, single-column result set that contains XML data. この場合、複数の行が返されると、ExecuteXmlReader メソッドは、XmlReader を最初の行の値にアタッチし、結果セットの残りの部分を破棄します。In this case, if more than one row is returned, the ExecuteXmlReader method attaches the XmlReader to the value on the first row, and discards the rest of the result set.

複数のアクティブな結果セット (MARS) 機能により、同じ接続を使用して複数のアクションを実行できます。The multiple active result set (MARS) feature allows for multiple actions using the same connection.

ExecuteReader または BeginExecuteReader を使用して XML データにアクセスする場合、SQL Server は、2033文字を超える XML 結果をそれぞれ2033文字の複数の行に返します。If you use ExecuteReader or BeginExecuteReader to access XML data, SQL Server will return any XML results greater than 2,033 characters in length in multiple rows of 2,033 characters each. この動作を回避するには、ExecuteXmlReader または BeginExecuteXmlReader を使用して FOR XML クエリを読み取ります。To avoid this behavior, use ExecuteXmlReader or BeginExecuteXmlReader to read FOR XML queries.

適用対象

こちらもご覧ください