Share via


DataReader Class

Provides the ability to expose data from any data.

Inheritance Hierarchy

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

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

Syntax

'Declaration
Public MustInherit Class DataReader _
    Implements IDisposable
public abstract class DataReader : IDisposable
public ref class DataReader abstract : IDisposable
[<AbstractClass>]
type DataReader =  
    class 
        interface IDisposable 
    end
public abstract class DataReader implements IDisposable

The DataReader type exposes the following members.

Constructors

  Name Description
Protected method DataReader Class constructor. Instantiates a nonparameterized instance of the DataReader class.

Top

Properties

  Name Description
Public property IsClosed Retrieves a Boolean value that indicates whether the specified reader has been closed.
Public property ItemCount Retrieves the number of items in the current block of data.
Public property Status Retrieves a numerical status code returned by the method currently providing data to the data reader.

Top

Methods

  Name Description
Public method Close Closes the DataReader instance.
Public method Dispose() Releases managed resources held for the current DataReader instance.
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.
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. (Overrides Object.Finalize().)
Public method GetBytes Retrieves a specified number of bytes of raw binary data.
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Public method GetItem(Int32) Retrieves the value of the item at the specified index in the current block of data.
Public method GetItem(String) Retrieves the value of a data item with the specified name in the current block of data.
Public method GetItemMaxLength Retrieves the maximum length, in characters, of data items at the specified index.
Public method GetItemName Retrieves the name assigned to the data item at the specified index, if any.
Public method GetItemType Retrieves the data type of a data item item, or items, at the specified index in a specified format.
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method IsNullItem Indicates whether the data item at the specified index is unspecified, that is, nulla null reference (Nothing in Visual Basic).
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method NextResult Advances the data reader to the next result in cases where the reader contains multiple results.
Public method Read Advances the reader to the next block of data in cases where the reader contains more than one block.
Public method Terminate Terminates the data reader immediately, without necessarily returning all of the data nor setting output parameters.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

All base-level data retrieval mechanisms 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 Namespace

AdoDotNetDataReader