OdbcDataReader Class

OdbcDataReader Class

 

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

Namespace:   System.Data.Odbc
Assembly:  System.Data (in System.Data.dll)

System.Object
  System.MarshalByRefObject
    System.Data.Common.DbDataReader
      System.Data.Odbc.OdbcDataReader

public sealed class OdbcDataReader : DbDataReader

NameDescription
System_CAPS_pubpropertyDepth

Gets a value that indicates the depth of nesting for the current row.(Overrides DbDataReader.Depth.)

System_CAPS_pubpropertyFieldCount

Gets the number of columns in the current row.(Overrides DbDataReader.FieldCount.)

System_CAPS_pubpropertyHasRows

Gets a value that indicates whether the OdbcDataReader contains one or more rows.(Overrides DbDataReader.HasRows.)

System_CAPS_pubpropertyIsClosed

Indicates whether the OdbcDataReader is closed.(Overrides DbDataReader.IsClosed.)

System_CAPS_pubpropertyItem[Int32]

Gets the value of the specified column in its native format given the column ordinal.(Overrides DbDataReader.Item[Int32].)

System_CAPS_pubpropertyItem[String]

Gets the value of the specified column in its native format given the column name.(Overrides DbDataReader.Item[String].)

System_CAPS_pubpropertyRecordsAffected

Gets the number of rows changed, inserted, or deleted by execution of the SQL statement.(Overrides DbDataReader.RecordsAffected.)

System_CAPS_pubpropertyVisibleFieldCount

Gets the number of fields in the DbDataReader that are not hidden.(Inherited from DbDataReader.)

NameDescription
System_CAPS_pubmethodClose()

Closes the OdbcDataReader object.(Overrides DbDataReader.Close().)

System_CAPS_pubmethodCreateObjRef(Type)

Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodDispose()

Releases all resources used by the current instance of the DbDataReader class.(Inherited from DbDataReader.)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_pubmethodGetBoolean(Int32)

Gets the value of the specified column as a Boolean.(Overrides DbDataReader.GetBoolean(Int32).)

System_CAPS_pubmethodGetByte(Int32)

Gets the value of the specified column as a byte.(Overrides DbDataReader.GetByte(Int32).)

System_CAPS_pubmethodGetBytes(Int32, Int64, Byte[], Int32, Int32)

Reads a stream of bytes from the specified column offset into the buffer as an array, starting at the particular buffer offset.(Overrides DbDataReader.GetBytes(Int32, Int64, Byte[], Int32, Int32).)

System_CAPS_pubmethodGetChar(Int32)

Gets the value of the specified column as a character.(Overrides DbDataReader.GetChar(Int32).)

System_CAPS_pubmethodGetChars(Int32, Int64, Char[], Int32, Int32)

Reads a stream of characters from the specified column offset into the buffer as an array, starting at the particular buffer offset.(Overrides DbDataReader.GetChars(Int32, Int64, Char[], Int32, Int32).)

System_CAPS_pubmethodGetData(Int32)

Returns a DbDataReader object for the requested column ordinal.(Inherited from DbDataReader.)

System_CAPS_pubmethodGetDataTypeName(Int32)

Gets the name of the source data type.(Overrides DbDataReader.GetDataTypeName(Int32).)

System_CAPS_pubmethodGetDate(Int32)

Gets the value of the specified column as a DateTime object.

System_CAPS_pubmethodGetDateTime(Int32)

Gets the value of the specified column as a DateTime object.(Overrides DbDataReader.GetDateTime(Int32).)

System_CAPS_pubmethodGetDecimal(Int32)

Gets the value of the specified column as a Decimal object.(Overrides DbDataReader.GetDecimal(Int32).)

System_CAPS_pubmethodGetDouble(Int32)

Gets the value of the specified column as a double-precision floating-point number.(Overrides DbDataReader.GetDouble(Int32).)

System_CAPS_pubmethodGetEnumerator()

Returns an IEnumerator that can be used to iterate through the rows in the data reader.(Overrides DbDataReader.GetEnumerator().)

System_CAPS_pubmethodGetFieldType(Int32)

Gets the Type that is the data type of the object.(Overrides DbDataReader.GetFieldType(Int32).)

System_CAPS_pubmethodGetFieldValue<T>(Int32)

Synchronously gets the value of the specified column as a type.(Inherited from DbDataReader.)

System_CAPS_pubmethodGetFieldValueAsync<T>(Int32)

Asynchronously gets the value of the specified column as a type.(Inherited from DbDataReader.)

System_CAPS_pubmethodGetFieldValueAsync<T>(Int32, CancellationToken)

Asynchronously gets the value of the specified column as a type.(Inherited from DbDataReader.)

System_CAPS_pubmethodGetFloat(Int32)

Gets the value of the specified column as a single-precision floating-point number.(Overrides DbDataReader.GetFloat(Int32).)

System_CAPS_pubmethodGetGuid(Int32)

Gets the value of the specified column as a globally unique identifier (GUID).(Overrides DbDataReader.GetGuid(Int32).)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetInt16(Int32)

Gets the value of the specified column as a 16-bit signed integer.(Overrides DbDataReader.GetInt16(Int32).)

System_CAPS_pubmethodGetInt32(Int32)

Gets the value of the specified column as a 32-bit signed integer.(Overrides DbDataReader.GetInt32(Int32).)

System_CAPS_pubmethodGetInt64(Int32)

Gets the value of the specified column as a 64-bit signed integer.(Overrides DbDataReader.GetInt64(Int32).)

System_CAPS_pubmethodGetLifetimeService()

Retrieves the current lifetime service object that controls the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodGetName(Int32)

Gets the name of the specified column.(Overrides DbDataReader.GetName(Int32).)

System_CAPS_pubmethodGetOrdinal(String)

Gets the column ordinal, given the name of the column.(Overrides DbDataReader.GetOrdinal(String).)

System_CAPS_pubmethodGetProviderSpecificFieldType(Int32)

Returns the provider-specific field type of the specified column.(Inherited from DbDataReader.)

System_CAPS_pubmethodGetProviderSpecificValue(Int32)

Gets the value of the specified column as an instance of Object.(Inherited from DbDataReader.)

System_CAPS_pubmethodGetProviderSpecificValues(Object[])

Gets all provider-specific attribute columns in the collection for the current row.(Inherited from DbDataReader.)

System_CAPS_pubmethodGetSchemaTable()

Returns a DataTable that describes the column metadata of the OdbcDataReader.(Overrides DbDataReader.GetSchemaTable().)

System_CAPS_pubmethodGetStream(Int32)

Retrieves data as a Stream.(Inherited from DbDataReader.)

System_CAPS_pubmethodGetString(Int32)

Gets the value of the specified column as a String.(Overrides DbDataReader.GetString(Int32).)

System_CAPS_pubmethodGetTextReader(Int32)

Retrieves data as a TextReader.(Inherited from DbDataReader.)

System_CAPS_pubmethodGetTime(Int32)

Gets the value of the specified column as a TimeSpan object.

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodGetValue(Int32)

Gets the value of the column at the specified ordinal in its native format.(Overrides DbDataReader.GetValue(Int32).)

System_CAPS_pubmethodGetValues(Object[])

Populates an array of objects with the column values of the current row.(Overrides DbDataReader.GetValues(Object[]).)

System_CAPS_pubmethodInitializeLifetimeService()

Obtains a lifetime service object to control the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodIsDBNull(Int32)

Gets a value that indicates whether the column contains nonexistent or missing values.(Overrides DbDataReader.IsDBNull(Int32).)

System_CAPS_pubmethodIsDBNullAsync(Int32)

An asynchronous version of IsDBNull, which gets a value that indicates whether the column contains non-existent or missing values.(Inherited from DbDataReader.)

System_CAPS_pubmethodIsDBNullAsync(Int32, CancellationToken)

An asynchronous version of IsDBNull, which gets a value that indicates whether the column contains non-existent or missing values. Optionally, sends a notification that operations should be cancelled.(Inherited from DbDataReader.)

System_CAPS_pubmethodNextResult()

Advances the OdbcDataReader to the next result when reading the results of batch SQL statements.(Overrides DbDataReader.NextResult().)

System_CAPS_pubmethodNextResultAsync()

An asynchronous version of NextResult, which advances the reader to the next result when reading the results of a batch of statements.

Invokes NextResultAsync with CancellationToken.None.(Inherited from DbDataReader.)

System_CAPS_pubmethodNextResultAsync(CancellationToken)

This is the asynchronous version of NextResult. Providers should override with an appropriate implementation. The cancellationToken may optionally be ignored.

The default implementation invokes the synchronous NextResult method and returns a completed task, blocking the calling thread. The default implementation will return a cancelled task if passed an already cancelled cancellationToken. Exceptions thrown by NextResult will be communicated via the returned Task Exception property.

Other methods and properties of the DbDataReader object should not be invoked while the returned Task is not yet completed.(Inherited from DbDataReader.)

System_CAPS_pubmethodRead()

Advances the OdbcDataReader to the next record.(Overrides DbDataReader.Read().)

System_CAPS_pubmethodReadAsync()

An asynchronous version of Read, which advances the reader to the next record in a result set. This method invokes ReadAsync with CancellationToken.None.(Inherited from DbDataReader.)

System_CAPS_pubmethodReadAsync(CancellationToken)

This is the asynchronous version of Read. Providers should override with an appropriate implementation. The cancellationToken may optionally be ignored.

The default implementation invokes the synchronous Read method and returns a completed task, blocking the calling thread. The default implementation will return a cancelled task if passed an already cancelled cancellationToken. Exceptions thrown by Read will be communicated via the returned Task Exception property.

Do not invoke other methods and properties of the DbDataReader object until the returned Task is complete.(Inherited from DbDataReader.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIDataRecord.GetData(Int32)

For a description of this member, see IDataRecord.GetData.(Inherited from DbDataReader.)

NameDescription
System_CAPS_pubmethodAsParallel()

Overloaded. Enables parallelization of a query.(Defined by ParallelEnumerable.)

System_CAPS_pubmethodAsQueryable()

Overloaded. Converts an IEnumerable to an IQueryable.(Defined by Queryable.)

System_CAPS_pubmethodCast<TResult>()

Casts the elements of an IEnumerable to the specified type.(Defined by Enumerable.)

System_CAPS_pubmethodOfType<TResult>()

Filters the elements of an IEnumerable based on a specified type.(Defined by Enumerable.)

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

While the OdbcDataReader is being used, the associated OdbcConnection is busy serving the OdbcDataReader, and no other operations can be performed on the OdbcConnection other than closing it. This is the case until the Close method of the OdbcDataReader is called. 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 OdbcDataReader. However, the precise behavior is both driver and timing dependent.

IsClosed and RecordsAffected are the only properties that you can call after the OdbcDataReader is closed. Sometimes, you must call Close before you can call RecordsAffected.

The following example creates an OdbcConnection, an OdbcCommand, and an OdbcDataReader. The example reads through the data, writing it out to the console. Finally, the example closes the OdbcDataReader, and then the OdbcConnection.

public static void ReadData(string connectionString)
{
    string queryString = "SELECT DISTINCT CustomerID FROM Orders";

    using (OdbcConnection connection = new OdbcConnection(connectionString))
    {
        OdbcCommand command = new OdbcCommand(queryString, connection);

        connection.Open();

        // Execute the DataReader and access the data.
        OdbcDataReader reader = command.ExecuteReader();
        while (reader.Read())
        {
            Console.WriteLine("CustomerID={0}", reader[0]);
        }

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

.NET Framework
Available since 1.1

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2016 Microsoft