AdoDotNetTableReader Class

Article
2011-02-23

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.Framework.DataReader
Microsoft.VisualStudio.Data.Framework.AdoDotNet.AdoDotNetTableReader

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

Syntax

'Declaration
Public Class AdoDotNetTableReader _
    Inherits DataReader

public class AdoDotNetTableReader : DataReader

public ref class AdoDotNetTableReader : public DataReader

type AdoDotNetTableReader =  
    class
        inherit DataReader
    end

public class AdoDotNetTableReader extends DataReader

The AdoDotNetTableReader type exposes the following members.

Constructors

	Name	Description
	AdoDotNetTableReader(DataTable)	Initializes a parameterized instance of the T:Microsoft.VisualStudio.Data.Framework.AdoDotNet.AdoDotNetDataTableReader class along with a DataTable instance.
	AdoDotNetTableReader(DataTable, Int32)	Initializes a parameterized instance of the AdoDotNetDataTableReader class along with a DataTable instance and a status value.

Top

Properties

	Name	Description
	Descriptor	Gets information that describes the data from a data source. (Inherited from DataReader.)
	HasDescriptor	Gets a value indicating whether the data parameter exposes its IVsDataReaderDescriptor implementation through the Descriptor() property. (Overrides DataReader.HasDescriptor.)
	IsClosed	Gets a value indicating whether the DataTable is closed. (Overrides DataReader.IsClosed.)
	ItemCount	Gets an integer value specifying the number of data items contained in the current DataTable instance. (Overrides DataReader.ItemCount.)
	Status	Gets an integer value representing the status of the data table; however, invariably returns zero. (Overrides DataReader.Status.)
	UnderlyingTable	Gets the underlying DataTable object instance used in this class.

Top

Methods

	Name	Description
	Close	Closes the current DataTable 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 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(String, array<Byte[], Int32, Int32)	Retrieves a specified number of bytes of raw binary data. (Inherited from DataReader.)
	GetBytes(Int32, array<Byte[], Int32, Int32)	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).)
	GetItemIndex	Retrieves the index of the data item for the specified data item name. (Overrides DataReader.GetItemIndex(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(Int32)	Retrieves the data type of a data item, or items, at the specified index for the default format Default. (Inherited from DataReader.)
	GetItemType(Int32, DataItemTypeFormat)	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(String)	Indicates whether the value of the given data item is unspecified, that is, nulla null reference (Nothing in Visual Basic). (Inherited from DataReader.)
	IsNullItem(Int32)	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 or setting output parameters. (Inherited from DataReader.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

It is unlikely that DDEX providers 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