1 out of 1 rated this helpful - Rate this topic

OleDbDataReader Class

Provides a way of reading a forward-only stream of data rows from a data source. This class cannot be inherited.

System.Object
  System.MarshalByRefObject
    System.Data.Common.DbDataReader
      System.Data.OleDb.OleDbDataReader

Namespace:  System.Data.OleDb
Assembly:  System.Data (in System.Data.dll)
public sealed class OleDbDataReader : DbDataReader

The OleDbDataReader type exposes the following members.

  Name Description
Public property Depth Gets a value that indicates the depth of nesting for the current row. (Overrides DbDataReader.Depth.)
Public property FieldCount Gets the number of columns in the current row. (Overrides DbDataReader.FieldCount.)
Public property HasRows Gets a value that indicates whether the OleDbDataReader contains one or more rows. (Overrides DbDataReader.HasRows.)
Public property IsClosed Indicates whether the data reader is closed. (Overrides DbDataReader.IsClosed.)
Public property Item[Int32] Gets the value of the specified column in its native format given the column ordinal. (Overrides DbDataReader.Item[Int32].)
Public property Item[String] Gets the value of the specified column in its native format given the column name. (Overrides DbDataReader.Item[String].)
Public property RecordsAffected Gets the number of rows changed, inserted, or deleted by execution of the SQL statement. (Overrides DbDataReader.RecordsAffected.)
Public property VisibleFieldCount Gets the number of fields in the OleDbDataReader that are not hidden. (Overrides DbDataReader.VisibleFieldCount.)
Top
  Name Description
Public method Close Closes the OleDbDataReader object. (Overrides DbDataReader.Close().)
Public method CreateObjRef Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
Public method Dispose() Releases all resources used by the current instance of the DbDataReader class. (Inherited from DbDataReader.)
Protected method Dispose(Boolean) Releases the managed resources used by the DbDataReader and optionally releases the unmanaged resources. (Inherited from DbDataReader.)
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetBoolean Gets the value of the specified column as a Boolean. (Overrides DbDataReader.GetBoolean(Int32).)
Public method GetByte Gets the value of the specified column as a byte. (Overrides DbDataReader.GetByte(Int32).)
Public method GetBytes Reads a stream of bytes from the specified column offset into the buffer as an array starting at the given buffer offset. (Overrides DbDataReader.GetBytes(Int32, Int64, Byte[], Int32, Int32).)
Public method GetChar Gets the value of the specified column as a character. (Overrides DbDataReader.GetChar(Int32).)
Public method GetChars Reads a stream of characters from the specified column offset into the buffer as an array starting at the given buffer offset. (Overrides DbDataReader.GetChars(Int32, Int64, Char[], Int32, Int32).)
Public method GetData Returns an OleDbDataReader object for the requested column ordinal.
Public method GetDataTypeName Gets the name of the source data type. (Overrides DbDataReader.GetDataTypeName(Int32).)
Public method GetDateTime Gets the value of the specified column as a DateTime object. (Overrides DbDataReader.GetDateTime(Int32).)
Protected method GetDbDataReader Returns a DbDataReader object for the requested column ordinal that can be overridden with a provider-specific implementation. (Inherited from DbDataReader.)
Public method GetDecimal Gets the value of the specified column as a Decimal object. (Overrides DbDataReader.GetDecimal(Int32).)
Public method GetDouble Gets the value of the specified column as a double-precision floating-point number. (Overrides DbDataReader.GetDouble(Int32).)
Public method GetEnumerator Returns an IEnumerator that can be used to iterate through the rows in the data reader. (Overrides DbDataReader.GetEnumerator().)
Public method GetFieldType Gets the Type that is the data type of the object. (Overrides DbDataReader.GetFieldType(Int32).)
Public method GetFloat Gets the value of the specified column as a single-precision floating-point number. (Overrides DbDataReader.GetFloat(Int32).)
Public method GetGuid Gets the value of the specified column as a globally unique identifier (GUID). (Overrides DbDataReader.GetGuid(Int32).)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetInt16 Gets the value of the specified column as a 16-bit signed integer. (Overrides DbDataReader.GetInt16(Int32).)
Public method GetInt32 Gets the value of the specified column as a 32-bit signed integer. (Overrides DbDataReader.GetInt32(Int32).)
Public method GetInt64 Gets the value of the specified column as a 64-bit signed integer. (Overrides DbDataReader.GetInt64(Int32).)
Public method GetLifetimeService Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public method GetName Gets the name of the specified column. (Overrides DbDataReader.GetName(Int32).)
Public method GetOrdinal Gets the column ordinal, given the name of the column. (Overrides DbDataReader.GetOrdinal(String).)
Public method GetProviderSpecificFieldType Returns the provider-specific field type of the specified column. (Inherited from DbDataReader.)
Public method GetProviderSpecificValue Gets the value of the specified column as an instance of Object. (Inherited from DbDataReader.)
Public method GetProviderSpecificValues Gets all provider-specific attribute columns in the collection for the current row. (Inherited from DbDataReader.)
Public method GetSchemaTable Returns a DataTable that describes the column metadata of the OleDbDataReader. (Overrides DbDataReader.GetSchemaTable().)
Public method GetString Gets the value of the specified column as a string. (Overrides DbDataReader.GetString(Int32).)
Public method GetTimeSpan Gets the value of the specified column as a TimeSpan object.
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method GetValue Gets the value of the column at the specified ordinal in its native format. (Overrides DbDataReader.GetValue(Int32).)
Public method GetValues Populates an array of objects with the column values of the current row. (Overrides DbDataReader.GetValues(Object[]).)
Public method InitializeLifetimeService Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public method IsDBNull Gets a value that indicates whether the column contains nonexistent or missing values. (Overrides DbDataReader.IsDBNull(Int32).)
Protected method MemberwiseClone() Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method MemberwiseClone(Boolean) Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
Public method NextResult Advances the data reader to the next result, when reading the results of batch SQL statements. (Overrides DbDataReader.NextResult().)
Public method Read Advances the OleDbDataReader to the next record. (Overrides DbDataReader.Read().)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top
  Name Description
Explicit interface implemetation Private method IDataRecord.GetData For a description of this member, see IDataRecord.GetData. (Inherited from DbDataReader.)
Top

To create an OleDbDataReader, you must call the ExecuteReader method of the OleDbCommand object, instead of directly using a constructor.

Before you close the OleDbConnection, first close the OleDbDataReader object. You must also close the OleDbDataReader object if you plan to resuse an OleDbCommand object.For example, you cannot retrieve output parameters until after you call Close.

Changes made to a result set by another process or thread while data is being read may be visible to the user of the OleDbDataReader. However, the precise behavior is timing dependent.

IsClosed and RecordsAffected are the only properties that you can call after the OleDbDataReader is closed. Although the RecordsAffected property may be accessed while the OleDbDataReader exists, always call Close before returning the value of RecordsAffected to guarantee an accurate return value.

The following example creates an OleDbConnection, an OleDbCommand, and an OleDbDataReader. The example reads through the data, writing it out to the console. Finally, the example closes the OleDbDataReader and then the OleDbConnection.


public static void ReadData(string connectionString, string queryString)
{
    using (OleDbConnection connection = new OleDbConnection(connectionString))
    {
        OleDbCommand command = new OleDbCommand(queryString, connection);

        connection.Open();
        OleDbDataReader reader = command.ExecuteReader();

        while (reader.Read())
        {
            Console.WriteLine(reader[0].ToString());
        }
        reader.Close();
    }
}


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ