IDataReader インターフェイス

定義

データ ソースでのコマンド実行により取得された結果セットの 1 つ以上の順方向専用ストリームを読み取る手段を提供し、リレーショナル データベースにアクセスする .NET Framework データ プロバイダーによって実装されます。Provides a means of reading one or more forward-only streams of result sets obtained by executing a command at a data source, and is implemented by .NET Framework data providers that access relational databases.

public interface class IDataReader : IDisposable, System::Data::IDataRecord
public interface IDataReader : IDisposable, System.Data.IDataRecord
type IDataReader = interface
    interface IDisposable
    interface IDataRecord
Public Interface IDataReader
Implements IDataRecord, IDisposable
派生
実装

次の例では、派生クラスSqlConnection SqlCommand、、、およびSqlDataReaderのインスタンスを作成します。The following example creates instances of the derived classes, SqlConnection, SqlCommand, and SqlDataReader. この例では、データを読み取り、コンソールに書き込みます。The example reads through the data, writing it out to the console. 最後に、この例でSqlDataReaderは、をSqlConnection閉じてから、を閉じます。Finally, the example closes the SqlDataReader, then the SqlConnection.

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


class Program
{
    static void Main()
    {
        string str = "Data Source=(local);Initial Catalog=Northwind;"
            + "Integrated Security=SSPI";
        ReadOrderData(str);
    }

    private static void ReadOrderData(string connectionString)
    {
        string queryString =
            "SELECT OrderID, CustomerID FROM dbo.Orders;";

        using (SqlConnection connection =
                   new SqlConnection(connectionString))
        {
            SqlCommand command =
                new SqlCommand(queryString, connection);
            connection.Open();

            SqlDataReader reader = command.ExecuteReader();

            // Call Read before accessing data.
            while (reader.Read())
            {
                ReadSingleRow((IDataRecord)reader);
            }

            // Call Close when done reading.
            reader.Close();
        }
    }

    private static void ReadSingleRow(IDataRecord record)
    {
        Console.WriteLine(String.Format("{0}, {1}", record[0], record[1]));
    }

}
Option Explicit On
Option Strict On

Imports System.Data
Imports System.Data.SqlClient

Module Module1

    Sub Main()
        Dim str As String = "Data Source=(local);Initial Catalog=Northwind;" _
       & "Integrated Security=SSPI;"
        ReadOrderData(str)
    End Sub

    Private Sub ReadOrderData(ByVal connectionString As String)
        Dim queryString As String = _
            "SELECT OrderID, CustomerID FROM dbo.Orders;"

        Using connection As New SqlConnection(connectionString)
            Dim command As New SqlCommand(queryString, connection)
            connection.Open()

            Dim reader As SqlDataReader = command.ExecuteReader()

            ' Call Read before accessing data.
            While reader.Read()
                ReadSingleRow(CType(reader, IDataRecord))
            End While

            ' Call Close when done reading.
            reader.Close()
        End Using
    End Sub

    Private Sub ReadSingleRow(ByVal record As IDataRecord)
       Console.WriteLine(String.Format("{0}, {1}", record(0), record(1)))

    End Sub

End Module

注釈

インターフェイスとインターフェイスを使用するとIDataRecordDataReader継承クラスでクラスを実装できるようになります。これにより、結果セットの1つ以上の順方向専用ストリームを読み取ることができます。 IDataReaderThe IDataReader and IDataRecord interfaces allow an inheriting class to implement a DataReader class, which provides a means of reading one or more forward-only streams of result sets. DataReaderクラスの詳細については、「 DataReader を使用したデータの取得」を参照してください。For more information about DataReader classes, see Retrieving Data Using a DataReader.

アプリケーションは、 IDataReaderインターフェイスのインスタンスを直接作成するのではなく、を継承IDataReaderするクラスのインスタンスを作成します。An application does not create an instance of the IDataReader interface directly, but creates an instance of a class that inherits IDataReader.

継承IDataReaderするクラスは、継承されたメンバーを実装する必要があり、通常は、プロバイダー固有の機能を追加するための追加メンバーを定義します。Classes that inherit IDataReader must implement the inherited members, and typically define additional members to add provider-specific functionality.

データの読み取り中に別のプロセスまたはスレッドによって結果セットに加えられた変更は、 IDataReaderを実装するクラスのユーザーに表示される場合があります。Changes made to a result set by another process or thread while data is being read may be visible to the user of a class that implements an IDataReader. ただし、正確な動作は、プロバイダーとタイミングに依存します。However, the precise behavior is both provider and timing dependent.

注意 (実装者)

.NET Framework データプロバイダー間の一貫性を高めるには、フォームPrvコマンドに継承クラスの名前を付けます。ここPrvで、は、特定の .NET Framework データプロバイダーの名前空間のすべてのクラスに指定された一様なプレフィックスです。To promote consistency among .NET Framework data providers, name the inheriting class in the form Prv Command where Prv is the uniform prefix given to all classes in a specific .NET Framework data provider namespace. たとえば、 SqlSystem.Data.SqlClient名前空間のSqlDataAdapterクラスのプレフィックスです。For example, Sql is the prefix of the SqlDataAdapter class in the System.Data.SqlClient namespace.

ユーザーは、 DataReaderクラスのインスタンスを直接作成しません。Users do not create an instance of a DataReader class directly. 代わりに、 DataReader オブジェクトCommandExecuteReaderメソッドを使用してインスタンスを取得します。Instead, they obtain the DataReader instance through the ExecuteReader method of the Command object. したがって、コンストラクターをDataReader内部としてマークする必要があります。Therefore, you should mark DataReader constructors as internal.

プロパティ

Depth

現在の行の入れ子の深さを示す値を取得します。Gets a value indicating the depth of nesting for the current row.

FieldCount

現在の行の列の数を取得します。Gets the number of columns in the current row.

(継承元 IDataRecord)
IsClosed

データ リーダーが閉じているかどうかを示す値を取得します。Gets a value indicating whether the data reader is closed.

Item[Int32]

指定したインデックスにある列を取得します。Gets the column located at the specified index.

(継承元 IDataRecord)
Item[String]

指定された名前を持つ列を取得します。Gets the column with the specified name.

(継承元 IDataRecord)
RecordsAffected

SQL ステートメントの実行によって変更、挿入、または削除された行の数を取得します。Gets the number of rows changed, inserted, or deleted by execution of the SQL statement.

メソッド

Close()

IDataReader オブジェクトを閉じます。Closes the IDataReader Object.

Dispose()

アンマネージ リソースの解放またはリセットに関連付けられているアプリケーション定義のタスクを実行します。Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

(継承元 IDisposable)
GetBoolean(Int32)

指定された列の値を Boolean として取得します。Gets the value of the specified column as a Boolean.

(継承元 IDataRecord)
GetByte(Int32)

指定された列の 8 ビット符号なし整数値を取得します。Gets the 8-bit unsigned integer value of the specified column.

(継承元 IDataRecord)
GetBytes(Int32, Int64, Byte[], Int32, Int32)

指定した列オフセットから、指定したバッファー オフセットから始まるバイトのストリームを、配列としてバッファーに読み取ります。Reads a stream of bytes from the specified column offset into the buffer as an array, starting at the given buffer offset.

(継承元 IDataRecord)
GetChar(Int32)

指定された列の文字値を取得します。Gets the character value of the specified column.

(継承元 IDataRecord)
GetChars(Int32, Int64, Char[], Int32, Int32)

指定した列オフセットから、指定したバッファー オフセットから始まる文字列ストリームを、配列としてバッファーに読み取ります。Reads a stream of characters from the specified column offset into the buffer as an array, starting at the given buffer offset.

(継承元 IDataRecord)
GetData(Int32)

指定された列序数の IDataReader を返します。Returns an IDataReader for the specified column ordinal.

(継承元 IDataRecord)
GetDataTypeName(Int32)

指定されたフィールドのデータ型情報を取得します。Gets the data type information for the specified field.

(継承元 IDataRecord)
GetDateTime(Int32)

指定されたフィールドの日付と時刻のデータ値を取得します。Gets the date and time data value of the specified field.

(継承元 IDataRecord)
GetDecimal(Int32)

指定されたフィールドの固定位置の数値を取得します。Gets the fixed-position numeric value of the specified field.

(継承元 IDataRecord)
GetDouble(Int32)

指定されたフィールドの倍精度浮動小数点値を取得します。Gets the double-precision floating point number of the specified field.

(継承元 IDataRecord)
GetFieldType(Int32)

GetValue(Int32) から返される Object の型に対応する Type 情報を取得します。Gets the Type information corresponding to the type of Object that would be returned from GetValue(Int32).

(継承元 IDataRecord)
GetFloat(Int32)

指定されたフィールドの単精度浮動小数点値を取得します。Gets the single-precision floating point number of the specified field.

(継承元 IDataRecord)
GetGuid(Int32)

指定したフィールドの GUID 値を返します。Returns the GUID value of the specified field.

(継承元 IDataRecord)
GetInt16(Int32)

指定されたフィールドの 16 ビット符号付き整数値を取得します。Gets the 16-bit signed integer value of the specified field.

(継承元 IDataRecord)
GetInt32(Int32)

指定されたフィールドの 32 ビット符号付き整数値を取得します。Gets the 32-bit signed integer value of the specified field.

(継承元 IDataRecord)
GetInt64(Int32)

指定されたフィールドの 64 ビット符号付き整数値を取得します。Gets the 64-bit signed integer value of the specified field.

(継承元 IDataRecord)
GetName(Int32)

検索するフィールドの名前を取得します。Gets the name for the field to find.

(継承元 IDataRecord)
GetOrdinal(String)

名前付きフィールドのインデックスを返します。Return the index of the named field.

(継承元 IDataRecord)
GetSchemaTable()

DataTable の列メタデータを記述する IDataReader を返します。Returns a DataTable that describes the column metadata of the IDataReader.

GetString(Int32)

指定したフィールドの文字列値を取得します。Gets the string value of the specified field.

(継承元 IDataRecord)
GetValue(Int32)

指定したフィールドの値を返します。Return the value of the specified field.

(継承元 IDataRecord)
GetValues(Object[])

現在のレコードの列の値を持つオブジェクトの配列を設定します。Populates an array of objects with the column values of the current record.

(継承元 IDataRecord)
IsDBNull(Int32)

指定されたフィールドが null に設定されているかどうかを返します。Return whether the specified field is set to null.

(継承元 IDataRecord)
NextResult()

バッチ SQL ステートメントの結果を読み取っているときに、次の結果にデータ リーダーを進めます。Advances the data reader to the next result, when reading the results of batch SQL statements.

Read()

IDataReader を次のレコードに進めます。Advances the IDataReader to the next record.

適用対象