OleDbDataReader Class

Definition

Namespace:

System.Data.OleDb

Assembly:

System.Data.OleDb.dll

Package:

System.Data.OleDb v9.0.0-rc.2.24473.5

Source:

OleDbDataReader.cs

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

public ref class OleDbDataReader sealed : System::Data::Common::DbDataReader

public sealed class OleDbDataReader : System.Data.Common.DbDataReader

type OleDbDataReader = class
    inherit DbDataReader

Public NotInheritable Class OleDbDataReader
Inherits DbDataReader

Inheritance

Object

DbDataReader

OleDbDataReader

Examples

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

Public Sub ReadData(ByVal connectionString As String, _
    ByVal queryString As String)
    Using connection As New OleDbConnection(connectionString)
        Dim command As New OleDbCommand(queryString, connection)

        connection.Open()

        Dim reader As OleDbDataReader = command.ExecuteReader()
        While reader.Read()
            Console.WriteLine(reader(0).ToString())
        End While
        reader.Close()
    End Using
End Sub

Remarks

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.

Properties

Depth	Gets a value that indicates the depth of nesting for the current row.
FieldCount	Gets the number of columns in the current row.
HasRows	Gets a value that indicates whether the OleDbDataReader contains one or more rows.
IsClosed	Indicates whether the data reader is closed.
Item[Int32]	Gets the value of the specified column in its native format given the column ordinal.
Item[String]	Gets the value of the specified column in its native format given the column name.
RecordsAffected	Gets the number of rows changed, inserted, or deleted by execution of the SQL statement.
VisibleFieldCount	Gets the number of fields in the OleDbDataReader that are not hidden.

Methods

Close()	Closes the OleDbDataReader object.
CloseAsync()	Asynchronously closes the DbDataReader object. (Inherited from DbDataReader)
Dispose()	Releases all resources used by the current instance of the DbDataReader class. (Inherited from DbDataReader)
Dispose(Boolean)	Releases the unmanaged resources used by the DbDataReader and optionally releases the managed resources. (Inherited from DbDataReader)
DisposeAsync()	Asynchronously releases all resources used by the current instance of the DbDataReader class. (Inherited from DbDataReader)
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetBoolean(Int32)	Gets the value of the specified column as a Boolean.
GetByte(Int32)	Gets the value of the specified column as a byte.
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.
GetChar(Int32)	Gets the value of the specified column as a character.
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.
GetColumnSchemaAsync(CancellationToken)	This is the asynchronous version of GetColumnSchema(DbDataReader). Providers should override with an appropriate implementation. The cancellationToken can optionally be honored. The default implementation invokes the synchronous GetColumnSchema(DbDataReader) call and returns a completed task. The default implementation will return a cancelled task if passed an already cancelled cancellationToken. Exceptions thrown by GetColumnSchema(DbDataReader) will be communicated via the returned Task Exception property. (Inherited from DbDataReader)
GetData(Int32)	Returns an OleDbDataReader object for the requested column ordinal.
GetDataTypeName(Int32)	Gets the name of the source data type.
GetDateTime(Int32)	Gets the value of the specified column as a DateTime object.
GetDbDataReader(Int32)	Returns a DbDataReader object for the requested column ordinal that can be overridden with a provider-specific implementation. (Inherited from DbDataReader)
GetDecimal(Int32)	Gets the value of the specified column as a Decimal object.
GetDouble(Int32)	Gets the value of the specified column as a double-precision floating-point number.
GetEnumerator()	Returns an IEnumerator that can be used to iterate through the rows in the data reader.
GetFieldType(Int32)	Gets the Type that is the data type of the object.
GetFieldValue<T>(Int32)	Gets the value of the specified column as the requested type. (Inherited from DbDataReader)
GetFieldValueAsync<T>(Int32, CancellationToken)	Asynchronously gets the value of the specified column as the requested type. (Inherited from DbDataReader)
GetFieldValueAsync<T>(Int32)	Asynchronously gets the value of the specified column as the requested type. (Inherited from DbDataReader)
GetFloat(Int32)	Gets the value of the specified column as a single-precision floating-point number.
GetGuid(Int32)	Gets the value of the specified column as a globally unique identifier (GUID).
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetInt16(Int32)	Gets the value of the specified column as a 16-bit signed integer.
GetInt32(Int32)	Gets the value of the specified column as a 32-bit signed integer.
GetInt64(Int32)	Gets the value of the specified column as a 64-bit signed integer.
GetName(Int32)	Gets the name of the specified column.
GetOrdinal(String)	Gets the column ordinal, given the name of the column.
GetProviderSpecificFieldType(Int32)	Gets the provider-specific type of the specified column. (Inherited from DbDataReader)
GetProviderSpecificValue(Int32)	Gets the value of the specified column as an instance of a provider-specific type. (Inherited from DbDataReader)
GetProviderSpecificValues(Object[])	Gets all provider-specific attribute columns in the collection for the current row. (Inherited from DbDataReader)
GetSchemaTable()	Returns a DataTable that describes the column metadata of the OleDbDataReader.
GetSchemaTableAsync(CancellationToken)	This is the asynchronous version of GetSchemaTable(). Providers should override with an appropriate implementation. The cancellationToken can optionally be honored. The default implementation invokes the synchronous GetSchemaTable() call and returns a completed task. The default implementation will return a cancelled task if passed an already cancelled cancellationToken. Exceptions thrown by GetSchemaTable() will be communicated via the returned Task Exception property. (Inherited from DbDataReader)
GetStream(Int32)	Gets a stream to retrieve data from the specified column. (Inherited from DbDataReader)
GetString(Int32)	Gets the value of the specified column as a string.
GetTextReader(Int32)	Gets a text reader to retrieve data from the column. (Inherited from DbDataReader)
GetTimeSpan(Int32)	Gets the value of the specified column as a TimeSpan object.
GetType()	Gets the Type of the current instance. (Inherited from Object)
GetValue(Int32)	Gets the value of the column at the specified ordinal in its native format.
GetValues(Object[])	Populates an array of objects with the column values of the current row.
IsDBNull(Int32)	Gets a value that indicates whether the column contains nonexistent or missing values.
IsDBNullAsync(Int32, CancellationToken)	Asynchronously gets a value that indicates whether the column contains non-existent or missing values. (Inherited from DbDataReader)
IsDBNullAsync(Int32)	Asynchronously gets a value that indicates whether the column contains non-existent or missing values. (Inherited from DbDataReader)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
NextResult()	Advances the data reader to the next result, when reading the results of batch SQL statements.
NextResultAsync()	Asynchronously advances the reader to the next result when reading the results of a batch of statements. (Inherited from DbDataReader)
NextResultAsync(CancellationToken)	Asynchronously advances the reader to the next result when reading the results of a batch of statements. (Inherited from DbDataReader)
Read()	Advances the OleDbDataReader to the next record.
ReadAsync()	Asynchronously advances the reader to the next record in a result set. (Inherited from DbDataReader)
ReadAsync(CancellationToken)	Asynchronously advances the reader to the next record in a result set. (Inherited from DbDataReader)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Extension Methods

See also

• DataAdapters and DataReaders