Share via

  • Article

TraceReplayOptions.DisplayPerfEvent Property

Gets or sets a value indicating whether an additional event that reports execution time is displayed for each replayed event.

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

Syntax

'Declaration
Public Property DisplayPerfEvent As Boolean
    Get
    Set
'Usage
Dim instance As TraceReplayOptions
Dim value As Boolean

value = instance.DisplayPerfEvent

instance.DisplayPerfEvent = value

public bool DisplayPerfEvent { get; set; }

public:
property bool DisplayPerfEvent {
    bool get ();
    void set (bool value);
}

member DisplayPerfEvent : bool with get, set

function get DisplayPerfEvent () : boolean
function set DisplayPerfEvent (value : boolean)

Property Value

Type: System.Boolean
True if the additional event is displayed for each replayed event; otherwise,false (default).

Remarks

When the value of DisplayPerfEvent is true, performance information is captured and reported for replayed events. The trace displays one performance event for each replayed event. The performance event includes the following performance information:

  • ExecutionTime. The elapsed time on the client in milliseconds between the submission of the query and the server's response.

  • **FetchAndExecutionTime.**The elapsed time on the client in milliseconds between the submission of the query and the fetching of all rows.