AdoDotNetSchemaReader Class

  • Article

Provides a means for obtaining the schema of the IDataReader object encapsulating the result set.

Inheritance Hierarchy

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

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

Syntax

'Declaration
Public Class AdoDotNetSchemaReader _
    Inherits DataReader

public class AdoDotNetSchemaReader : DataReader

public ref class AdoDotNetSchemaReader : public DataReader

type AdoDotNetSchemaReader =  
    class
        inherit DataReader
    end

public class AdoDotNetSchemaReader extends DataReader

The AdoDotNetSchemaReader type exposes the following members.

Constructors

  Name Description
Public method AdoDotNetSchemaReader(IDataReader) Class constructor. Initializes a new instance of the AdoDotNetSchemaReader class with an IDataReader.
Public method AdoDotNetSchemaReader(IDataReader, IDbCommand) Class constructor. Initializes a new instance of the AdoDotNetSchemaReader class with IDataReader and IDbCommand objects.

Top

Properties

  Name Description
Public property InnerDataReader Provides a means for accessing the underlying IDataReader object directly.
Public property IsClosed Retrieves a Boolean value indicating whether or not the AdoDotNetSchemaReader is closed. (Overrides DataReader.IsClosed.)
Public property ItemCount Retrieves an integer value specifying the number of data items contained in the current AdoDotNetSchemaReader instance. (Overrides DataReader.ItemCount.)
Public property SchemaTable Retrieves the DataTable object that represents the schema of the IDataReader passed into the constructor of the AdoDotNetSchemaReader.
Public property Status Retrieves a numerical status code returned by the method currently providing data to the DataReader object. (Overrides DataReader.Status.)

Top

Methods

  Name Description
Public method Close Closes the current AdoDotNetSchemaReader 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 AdoDotNetSchemaReader. (Overrides DataReader.NextResult().)
Public method Read Tests whether there is another data record and if true advances the AdoDotNetSchemaReader to the next record. (Overrides DataReader.Read().)
Public method Terminate Terminates the DataReader object immediately, without necessarily returning all of the data nor setting output parameters. (Overrides DataReader.Terminate().)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

Implements the IDataReader interface. This class takes as input an IDataReader object and expose the schema of the IDataReader object as a DDEX DataReader.

The format of the data reader exposed is that required by the DeriveSchema method, which has a fixed set of columns. It does not expose exactly the same information that is provided when calling the GetSchemaTable method on the underlying IDataReader instance.

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