This documentation is archived and is not being maintained.

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)

public abstract bool ShouldTrace(
	TraceEventCache cache,
	string source,
	TraceEventType eventType,
	int id,
	string formatOrMessage,
	Object[] args,
	Object data1,
	Object[] data


Type: System.Diagnostics.TraceEventCache

The TraceEventCache that contains information for the trace event.

Type: System.String

The name of the source.

Type: System.Diagnostics.TraceEventType

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

Type: System.Int32

A trace identifier number.

Type: System.String

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

Type: System.Object[]

An array of argument objects.

Type: System.Object

A trace data object.

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 null in the following parameters: args, data1, data, formatOrMessage, and cache. If the parameter value is null, the parameter is not part of the event. For example, if the args parameter is null, it means that the event does not have any arguments. If the data parameter is null, 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 null, the data1 parameter must also not be null.

It is guaranteed that the source parameter is not null 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.

public class ErrorFilter : TraceFilter
    public bool ShouldTrace(TraceEventCache cache, string source, 
        TraceEventType eventType, int id, string formatOrMessage,
        object[] args, object data, object[] dataArray)
        return eventType == TraceEventType.Error;

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0