AdoDotNetDataTableReader Class

  • Article

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
Public method AdoDotNetDataTableReader(DataTable) Class constructor. Initializes a parameterized instance of the AdoDotNetDataTableReader class along with a DataTable instance.
Public method 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
Public property InnerDataTable Provides a means for accessing the underlying DataTable object directly.
Public property IsClosed Retrieves a Boolean value indicating whether the DataTableReader is closed. (Overrides DataReader.IsClosed.)
Public property ItemCount Override. Retrieves an integer value specifying the number of data items contained in the current DataTableReader instance. (Overrides DataReader.ItemCount.)
Public property Status Retrieves an integer value representing the status of the data table; however, invariably returns zero. (Overrides DataReader.Status.)

Top

Methods

  Name Description
Public method Close Closes the current DataTableReader instance. (Overrides DataReader.Close().)
Public method Dispose() Releases managed resources held for the current DataReader instance. (Inherited from DataReader.)
Protected method 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.)
Public method Equals Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Finalizes the current DataReader instance. (Inherited from DataReader.)
Public method 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).)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetItem(Int32) Retrieves a data item at a specified index. (Overrides DataReader.GetItem(Int32).)
Public method GetItem(String) Retrieves a data item with a specified name. (Overrides DataReader.GetItem(String).)
Public method GetItemMaxLength Retrieves an integer value specifying the maximum length of the data item at the specified index. (Overrides DataReader.GetItemMaxLength(Int32).)
Public method GetItemName Retrieves the string literal name of the data item at the specified index. (Overrides DataReader.GetItemName(Int32).)
Public method 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).)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method 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).)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method NextResult Tests whether there is another result set and if true advances the AdoDotNetDataTableReader. (Overrides DataReader.NextResult().)
Public method Read Tests whether there is another data record and if true advances the AdoDotNetDataTableReader to the next record. (Overrides DataReader.Read().)
Public method Terminate Terminates the data reader immediately, without necessarily returning all of the data nor setting output parameters. (Inherited from DataReader.)
Public method 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.

See Also

Reference

Microsoft.VisualStudio.Data.AdoDotNet Namespace

DataTableReader