TechNet
Export (0) Print
Expand All

DataTableReader Class

 

The DataTableReader obtains the contents of one or more DataTable objects in the form of one or more read-only, forward-only result sets.

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

System.Object
  System.MarshalByRefObject
    System.Data.Common.DbDataReader
      System.Data.DataTableReader

public sealed class DataTableReader : DbDataReader

NameDescription
System_CAPS_pubmethodDataTableReader(DataTable)

Initializes a new instance of the DataTableReader class by using data from the supplied DataTable.

System_CAPS_pubmethodDataTableReader(DataTable[])

Initializes a new instance of the DataTableReader class using the supplied array of DataTable objects.

NameDescription
System_CAPS_pubpropertyDepth

The depth of nesting for the current row of the DataTableReader.(Overrides DbDataReader.Depth.)

System_CAPS_pubpropertyFieldCount

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

System_CAPS_pubpropertyHasRows

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

System_CAPS_pubpropertyIsClosed

Gets a value that indicates whether the DataTableReader 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 inserted, changed, 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 current DataTableReader.(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 starting at the specified column offset into the buffer as an array starting at the specified 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)

Returns the value of the specified column as a character array.(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 a string representing the data type of the specified column.(Overrides DbDataReader.GetDataTypeName(Int32).)

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.(Overrides DbDataReader.GetDecimal(Int32).)

System_CAPS_pubmethodGetDouble(Int32)

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

System_CAPS_pubmethodGetEnumerator()

Returns an enumerator that can be used to iterate through the item collection. (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 value of the specified column as a String.(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)

Gets the type of the specified column in provider-specific format.(Overrides DbDataReader.GetProviderSpecificFieldType(Int32).)

System_CAPS_pubmethodGetProviderSpecificValue(Int32)

Gets the value of the specified column in provider-specific format.(Overrides DbDataReader.GetProviderSpecificValue(Int32).)

System_CAPS_pubmethodGetProviderSpecificValues(Object[])

Fills the supplied array with provider-specific type information for all the columns in the DataTableReader.(Overrides DbDataReader.GetProviderSpecificValues(Object[]).)

System_CAPS_pubmethodGetSchemaTable()

Returns a DataTable that describes the column metadata of the DataTableReader.(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_pubmethodGetType()

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

System_CAPS_pubmethodGetValue(Int32)

Gets the value of the specified column 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 non-existent 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 DataTableReader to the next result set, if any.(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 DataTableReader 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.)

The DataTableReader works much like any other data reader, such as the SqlDataReader, except that the DataTableReader provides for iterating over rows in a DataTable. In other words, it provides for iterating over rows in a cache. The cached data can be modified while the DataTableReader is active, and the reader automatically maintains its position.

When you create a DataTableReader from a DataTable, the resulting DataTableReader object contains one result set with the same data as the DataTable from which it was created, except for any rows that have been marked as deleted. The columns appear in the same order as in the original DataTable. The structure of the returned result is identical in schema and data to the original DataTable. A DataTableReader that was created by calling the M:System.Data.DataSet.GetDataReader method of a DataSet object contains multiple result sets if the DataSetcontains more than one table. The results are in the same sequence as the DataTableobjects in the DataTableCollection of the DataSet object.

The returned result set contains only the current version of each DataRow; rows that are marked for deletion are skipped.

The DataTableReader provides a stable iterator; that is, the contents of the DataTableReader are not invalidated if the size of the underlying collection is modified during iteration. For example, if one or more rows in the Rows collection are deleted or removed during iteration, the current position within the DataTableReader is maintained appropriately and it does not invalidate the iterator.

.NET Framework
Available since 2.0

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