DataReader Class

Provides the ability to expose data from any data source.

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

public abstract class DataReader : IVsDataReader, 
	IDisposable, IVsDataReaderDescriptor

The DataReader type exposes the following members.

  NameDescription
Protected methodDataReaderInitializes a new instance of the DataReader class.
Top

  NameDescription
Public propertyDescriptorGets information that describes the data from a data source.
Protected propertyHasDescriptorGets a value indicating whether the data reader exposes its IVsDataReaderDescriptor implementation through the Descriptor property.
Public propertyIsClosedGets a Boolean value that indicates whether the specified reader has been closed.
Public propertyItemCountGets the number of items in the current block of data.
Public propertyStatusGets a numerical status code returned by the method currently providing data to the data reader.
Top

  NameDescription
Public methodCloseCloses the DataReader instance.
Public methodDispose()Releases managed resources held for the current DataReader instance.
Protected methodDispose(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.
Public methodEqualsDetermines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeFinalizes the current DataReader instance. (Overrides Object.Finalize().)
Public methodGetBytes(Int32, Byte[], Int32, Int32)Retrieves a specified number of bytes of raw binary data.
Public methodGetBytes(String, Byte[], Int32, Int32)Retrieves a specified number of bytes of raw binary data.
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetItem(Int32)Retrieves the value of the item at the specified index in the current block of data.
Public methodGetItem(String)Retrieves the value of a data item with the specified name in the current block of data.
Public methodGetItemIndexReturns the index corresponding to the specified item name in the block of data.
Public methodGetItemMaxLengthRetrieves the maximum length, in characters, of data items at the specified index.
Public methodGetItemNameRetrieves the name assigned to the data item at the specified index, if any.
Public methodGetItemType(Int32)Retrieves the data type of a data item, or items, at the specified index for the default format Default.
Public methodGetItemType(Int32, DataItemTypeFormat)Retrieves the data type of a data item, or items, at the specified index in a specified format.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIsNullItem(Int32)Indicates whether the data item at the specified index is unspecified, that is, null.
Public methodIsNullItem(String)Indicates whether the value of the given data item is unspecified, that is, null.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodNextResultAdvances the data reader to the next result set in cases where the reader contains multiple result sets.
Public methodReadAdvances the reader to the next block of data in cases where the reader contains more than one block of data.
Public methodTerminateTerminates the data reader immediately, without necessarily returning all of the data or setting output parameters.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

All base-level data retrieval mechanisms return a DataReader object.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft