• Article

TraceReader Class

The TraceReader class is an abstract Trace Object class that is used in the construction of the TraceServer class, the TraceTable class, and the TraceFile class.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Trace.TraceReader
    Microsoft.SqlServer.Management.Trace.TraceReaderWriter
    Microsoft.SqlServer.Management.Trace.TraceServer

Namespace:  Microsoft.SqlServer.Management.Trace
Assembly:  Microsoft.SqlServer.ConnectionInfoExtended (in Microsoft.SqlServer.ConnectionInfoExtended.dll)

Syntax

'Declaration
<ComVisibleAttribute(False)> _
Public Class TraceReader _
    Implements IDataReader, IDisposable, IDataRecord
'Usage
Dim instance As TraceReader

[ComVisibleAttribute(false)]
public class TraceReader : IDataReader, 
    IDisposable, IDataRecord

[ComVisibleAttribute(false)]
public ref class TraceReader : IDataReader, 
    IDisposable, IDataRecord

[<ComVisibleAttribute(false)>]
type TraceReader =  
    class
        interface IDataReader
        interface IDisposable
        interface IDataRecord
    end

public class TraceReader implements IDataReader, IDisposable, IDataRecord

The TraceReader type exposes the following members.

Constructors

  Name Description
Public method TraceReader Initializes a new instance of the TraceReader class.

Top

Properties

  Name Description
Public property Depth Gets the depth value for the trace reader.
Public property FieldCount Gets the number of columns in the data.
Public property IsClosed Gets the Boolean property value that specifies whether the trace reader is closed.
Public property Item[Int32] Gets the column specified by the index position.
Public property Item[String] Gets the column with the specified name.
Public property RecordsAffected Gets the number of records of data.

Top

Methods

  Name Description
Public method Close Closes the trace reader.
Public method Dispose Deletes the trace reader information.
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetBoolean Returns a Boolean value from the record at the specified column position.
Public method GetByte Returns a Byte value from the record at the specified column position.
Public method GetBytes Gets a stream of bytes from the specified column offset into the buffer as an array, starting at the given buffer offset.
Public method GetChar Gets a character value of the specified column.
Public method GetChars(Int32, array<Char[], Int32, Int32, Int32) Gets a character array value from the record at the specified column position.
Public method GetChars(Int32, Int64, array<Char[], Int32, Int32) Gets a character array value from the record at the specified column position.
Public method GetData Returns IDataReader object used when the field points to a remote data structure.
Public method GetDataTypeName Gets the data type of the data value at the specified column position.
Public method GetDateTime Gets a DateTime value of the data value at the specified column position.
Public method GetDecimal Gets a Decimal value of the data value at the specified column position.
Public method GetDouble Gets a floating point value of the data value at the specified column position.
Public method GetFieldType Returns the field type of the data value at the specified column position.
Public method GetFloat Gets a floating point value of the data value at the specified column position.
Public method GetGuid Gets a Guid system value of the data value at the specified column position.
Public method GetHashCode (Inherited from Object.)
Public method GetInt16 Gets a small integer value of the data value at the specified column position.
Public method GetInt32 Gets an integer value of the data value at the specified column position.
Public method GetInt64 Gets a long integer value of the data value at the specified column position.
Public method GetName Gets the name of the field at the specified column position.
Public method GetOrdinal Gets the ordinal value of the data value at the specified column position.
Public method GetSchemaTable Gets a table that describes the schema.
Public method GetStream Gets the stream of data.
Public method GetString Gets a String value at the specified column position.
Public method GetTimeSpan Gets a TimeSpan value of the data value at the specified column position.
Public method GetType (Inherited from Object.)
Public method GetValue Gets a value of the data value at the specified column position.
Public method GetValues Gets an array of values from the data value at the specified column position.
Public method IsDBNull Specifies whether the specified column is set to null.
Public method IsNull Gets a Boolean value that specifies whether value of the data at the specified column position is null.
Protected method MemberwiseClone (Inherited from Object.)
Public method NextResult Moves to the next result in the trace.
Public method Read Reads the trace record.
Public method ToString (Inherited from Object.)
Public method TranslateSubclass Translates the sub class.

Top

Fields

  Name Description
Protected field currentRow Specifies the current row.

Top

Remarks

The TraceReader class provides trace data reading functionality and access to data that is common to both the TraceServer class, the TraceTable class, and the TraceFile class.

The trace data reading functionality is also available on the TraceReaderWriter class, which is derived from the TraceReader class and is used in the construction of the TraceTable class and TraceFile class.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.

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.