DataReader Class

Reference

Definition

Namespace:: Microsoft.VisualStudio.Data.Framework

Assembly:: Microsoft.VisualStudio.Data.Framework.dll

Package:: Microsoft.VisualStudio.Data.Framework v17.10.40170

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Represents an implementation of the IVsDataReader and IVsDataReaderDescriptor interfaces.

public ref class DataReader abstract : IDisposable, Microsoft::VisualStudio::Data::Services::SupportEntities::IVsDataReader, Microsoft::VisualStudio::Data::Services::SupportEntities::IVsDataReaderDescriptor

public abstract class DataReader : IDisposable, Microsoft.VisualStudio.Data.Services.SupportEntities.IVsDataReader, Microsoft.VisualStudio.Data.Services.SupportEntities.IVsDataReaderDescriptor

type DataReader = class
    interface IVsDataReader
    interface IDisposable
    interface IVsDataReaderDescriptor

Public MustInherit Class DataReader
Implements IDisposable, IVsDataReader, IVsDataReaderDescriptor

Inheritance: Object
DataReader

Derived: Microsoft.VisualStudio.Data.Framework.AdoDotNet.AdoDotNetReader

Microsoft.VisualStudio.Data.Framework.AdoDotNet.AdoDotNetSchemaReader

Microsoft.VisualStudio.Data.Framework.AdoDotNet.AdoDotNetTableReader

Implements: IVsDataReader IVsDataReaderDescriptor IDisposable

Constructors

DataReader()

Initializes a new instance of the DataReader class.

Properties

Descriptor	Gets information that describes the data from a data source.
HasDescriptor	Gets a value indicating whether the data reader exposes its IVsDataReaderDescriptor implementation through the Descriptor property.
IsClosed	Gets a Boolean value that indicates whether the specified reader has been closed.
ItemCount	Gets the number of items in the current block of data.
Status	Gets a numerical status code returned by the method currently providing data to the data reader.

Methods

Close()	Closes the DataReader instance.
Dispose()	Releases managed resources held for the current DataReader instance.
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.
Finalize()	Finalizes the current DataReader instance.
GetBytes(Int32, Byte[], Int32, Int32)	Retrieves a specified number of bytes of raw binary data.
GetBytes(String, Byte[], Int32, Int32)	Retrieves a specified number of bytes of raw binary data.
GetItem(Int32)	Retrieves the value of the item at the specified index in the current block of data.
GetItem(String)	Retrieves the value of a data item with the specified name in the current block of data.
GetItemIndex(String)	Returns the index corresponding to the specified item name in the block of data.
GetItemMaxLength(Int32)	Retrieves the maximum length, in characters, of data items at the specified index.
GetItemName(Int32)	Retrieves the name assigned to the data item at the specified index, if any.
GetItemType(Int32, DataItemTypeFormat)	Retrieves the data type of a data item, or items, at the specified index in a specified format.
GetItemType(Int32)	Retrieves the data type of a data item, or items, at the specified index for the default format Default.
IsNullItem(Int32)	Indicates whether the data item at the specified index is unspecified, that is, null.
IsNullItem(String)	Indicates whether the value of the given data item is unspecified, that is, null.
NextResult()	Advances the data reader to the next result set in cases where the reader contains multiple result sets.
Read()	Advances the reader to the next block of data in cases where the reader contains more than one block of data.
Terminate()	Terminates the data reader immediately, without necessarily returning all of the data or setting output parameters.

Applies to

Share via