AdoDotNetDataTableReader Class

Article
10/03/2012

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

Inheritance Hierarchy

System.Object
Microsoft.VisualStudio.Data.DataReader
Microsoft.VisualStudio.Data.AdoDotNet.AdoDotNetDataTableReader

Namespace: Microsoft.VisualStudio.Data.AdoDotNet
Assembly: Microsoft.VisualStudio.Data (in Microsoft.VisualStudio.Data.dll)

Syntax

'Declaration
Public Class AdoDotNetDataTableReader _
    Inherits DataReader

public class AdoDotNetDataTableReader : DataReader

public ref class AdoDotNetDataTableReader : public DataReader

type AdoDotNetDataTableReader =  
    class 
        inherit DataReader 
    end

public class AdoDotNetDataTableReader extends DataReader

The AdoDotNetDataTableReader type exposes the following members.

Constructors

	Name	Description
	AdoDotNetDataTableReader(DataTable)	Class constructor. Initializes a parameterized instance of the AdoDotNetDataTableReader class along with a DataTable instance.
	AdoDotNetDataTableReader(DataTable, Int32)	Class constructor. Initializes a new instance of the AdoDotNetDataTableReader class along with a DataTable instance and a Status indicator.

Top

Properties

	Name	Description
	InnerDataTable	Provides a means for accessing the underlying DataTable object directly.
	IsClosed	Retrieves a Boolean value indicating whether the DataTableReader is closed. (Overrides DataReader.IsClosed.)
	ItemCount	Override. Retrieves an integer value specifying the number of data items contained in the current DataTableReader instance. (Overrides DataReader.ItemCount.)
	Status	Retrieves an integer value representing the status of the data table; however, invariably returns zero. (Overrides DataReader.Status.)

Top

Methods

	Name	Description
	Close	Closes the current DataTableReader instance. (Overrides DataReader.Close().)
	Dispose()	Releases managed resources held for the current DataReader instance. (Inherited from DataReader.)
	Dispose(Boolean)	Cleans up resources associated with the current DataReader instance, both when the public Dispose method is called and as well as when the object is finalized with a call to the Finalize method. (Inherited from DataReader.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Finalizes the current DataReader instance. (Inherited from DataReader.)
	GetBytes	Reads a stream of bytes into the buffer as an array, starting at a specified offset (Overrides DataReader.GetBytes(Int32, array<Byte[], Int32, Int32).)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetItem(Int32)	Retrieves a data item at a specified index. (Overrides DataReader.GetItem(Int32).)
	GetItem(String)	Retrieves a data item with a specified name. (Overrides DataReader.GetItem(String).)
	GetItemMaxLength	Retrieves an integer value specifying the maximum length of the data item at the specified index. (Overrides DataReader.GetItemMaxLength(Int32).)
	GetItemName	Retrieves the string literal name of the data item at the specified index. (Overrides DataReader.GetItemName(Int32).)
	GetItemType	Retrieves the data type for a data item at a specified index and with a specified item type format. (Overrides DataReader.GetItemType(Int32, DataItemTypeFormat).)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsNullItem	Retrieves a Boolean value indicating whether the data item at the specified index is nulla null reference (Nothing in Visual Basic). (Overrides DataReader.IsNullItem(Int32).)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	NextResult	Tests whether there is another result set and if true advances the AdoDotNetDataTableReader. (Overrides DataReader.NextResult().)
	Read	Tests whether there is another data record and if true advances the AdoDotNetDataTableReader to the next record. (Overrides DataReader.Read().)
	Terminate	Terminates the data reader immediately, without necessarily returning all of the data nor setting output parameters. (Inherited from DataReader.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

It is unlikely that a DDEX Provider will need to override or otherwise modify the behavior of this class; rather, they can simply instantiate it whenever they have an ADO.NET DataTable object in hand and they need to return a DataReader object.

Thread Safety

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

Share via