TraceFilter.ShouldTrace Method

When overridden in a derived class, determines whether the trace listener should trace the event.

Namespace:  System.Diagnostics
Assembly:  System (in System.dll)

abstract ShouldTrace : 
        cache:TraceEventCache * 
        source:string * 
        eventType:TraceEventType * 
        id:int * 
        formatOrMessage:string * 
        args:Object[] * 
        data1:Object * 
        data:Object[] -> bool

Parameters

cache
Type: System.Diagnostics.TraceEventCache

The TraceEventCache that contains information for the trace event.

source
Type: System.String

The name of the source.

eventType
Type: System.Diagnostics.TraceEventType

One of the TraceEventType values specifying the type of event that has caused the trace.

id
Type: System.Int32

A trace identifier number.

formatOrMessage
Type: System.String

Either the format to use for writing an array of arguments specified by the args parameter, or a message to write.

args
Type: System.Object[]

An array of argument objects.

data1
Type: System.Object

A trace data object.

data
Type: System.Object[]

An array of trace data objects.

Return Value

Type: System.Boolean
true to trace the specified event; otherwise, false.

Notes to Inheritors

Implementations of this method should return true if the event specified by the passed parameters should be traced. Otherwise the method should return false. For example, a filter that allows only error events to pass through to the listener should inspect the eventType parameter and return true if the trace event type level is set to TraceEventType.Error or greater; otherwise, it should return false.

Implementations of the method should be prepared to handle a null reference (Nothing in Visual Basic) in the following parameters: args, data1, data, formatOrMessage, and cache. If the parameter value is a null reference (Nothing in Visual Basic), the parameter is not part of the event. For example, if the args parameter is a null reference (Nothing in Visual Basic), it means that the event does not have any arguments. If the data parameter is a null reference (Nothing in Visual Basic), then there are either one or no data objects. If there is one data object, it will be found in the data1 parameter. The reason for the distinction between a single data object and an array of data objects is for performance. There is no reason to create an object array if only one object is traced, as is normally the case. If the data parameter is not a null reference (Nothing in Visual Basic), the data1 parameter must also not be a null reference (Nothing in Visual Basic).

It is guaranteed that the source parameter is not a null reference (Nothing in Visual Basic) and not an empty string ("").

Implementations of the method can optionally throw the following exceptions:

The following code example shows how to override the ShouldTrace method to indicate tracing should occur when the trace event type of the event is equal to TraceEventType.Error.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2015 Microsoft