TraceServer Class

Article
08/11/2014

The TraceServer class is a Trace object that represents a new trace on an instance of SQL Server.

Inheritance Hierarchy

System.Object
Microsoft.SqlServer.Management.Trace.TraceReader
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 TraceServer _
    Inherits TraceReader
'Usage
Dim instance As TraceServer

[ComVisibleAttribute(false)]
public class TraceServer : TraceReader

[ComVisibleAttribute(false)]
public ref class TraceServer : public TraceReader

[<ComVisibleAttribute(false)>]
type TraceServer =  
    class 
        inherit TraceReader 
    end

public class TraceServer extends TraceReader

The TraceServer type exposes the following members.

Constructors

	Name	Description
	TraceServer	Initializes a new instance of the TraceServer class.

Top

Properties

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

Top

Methods

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

Top

Fields

	Name	Description
	currentRow	Specifies the current row. (Inherited from TraceReader.)

Top

Remarks

With the TraceServer object you can:

Start a new trace.
Read a trace.

In addition to the Trace and Replay objects, the trace can be created manually by using SQL Server Profiler Reference or by using a set of Transact-SQL stored procedures called Introducing SQL Trace.

Examples

Readme_Tracer

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.