Share via

IVsDataReader Interface

  • Article

Represents the interface that exposes methods and properties for reading data from any data source.

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

Syntax

'Declaration
<DataClientObjectAttribute("29885742-32C5-46d3-A2A6-A28F4B6D746B")> _
Public Interface IVsDataReader _
    Inherits IDisposable

[DataClientObjectAttribute("29885742-32C5-46d3-A2A6-A28F4B6D746B")]
public interface IVsDataReader : IDisposable

[DataClientObjectAttribute(L"29885742-32C5-46d3-A2A6-A28F4B6D746B")]
public interface class IVsDataReader : IDisposable

[<DataClientObjectAttribute("29885742-32C5-46d3-A2A6-A28F4B6D746B")>]
type IVsDataReader =  
    interface
        interface IDisposable
    end

public interface IVsDataReader extends IDisposable

The IVsDataReader type exposes the following members.

Properties

  Name Description
Public property Descriptor When implemented by a class, gets information that describes the data from a data source.
Public property IsClosed When implemented by a class, gets a Boolean value that indicates whether the specified reader is closed.
Public property Status When implemented by a class, gets a numerical status code returned by the method currently providing data to the data reader.

Top

Methods

  Name Description
Public method Close When implemented by a class, closes the IVsDataReader instance.
Public method Dispose Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.)
Public method GetBytes(Int32, array<Byte[], Int32, Int32) When implemented by a class, retrieves a specified number of bytes of raw binary data.
Public method GetBytes(String, array<Byte[], Int32, Int32) When implemented by a class, retrieves a specified number of bytes of raw binary data.
Public method GetItem(Int32) When implemented by a class, retrieves the value of the item at the specified index in the current block of data.
Public method GetItem(String) When implemented by a class, retrieves the value of a data item with the specified name in the current block of data.
Public method IsNullItem(Int32) When implemented by a class, indicates whether the data item at the specified index is unspecified, that is, nulla null reference (Nothing in Visual Basic).
Public method IsNullItem(String) When implemented by a class, indicates whether the value of the given data item is unspecified, that is, nulla null reference (Nothing in Visual Basic).
Public method NextResult When implemented by a class, advances the data reader to the next result set, in cases where the reader contains multiple result sets.
Public method Read When implemented by a class, advances the reader to the next block of data, in cases where the reader contains more than one block of data.
Public method Terminate When implemented by a class, terminates the data reader immediately, without necessarily returning all of the data or setting output parameters.

Top

Remarks

This interface has a base implementation in the DDEX Framework.

See Also

Reference

Microsoft.VisualStudio.Data.Services.SupportEntities Namespace