This documentation is archived and is not being maintained.

SourceFilter Class

Indicates whether a listener should trace a message based on the source of a trace.


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

public ref class SourceFilter : public TraceFilter

The SourceFilter type exposes the following members.

Public methodSourceFilterInitializes a new instance of the SourceFilter class, specifying the name of the trace source.

Public propertySourceGets or sets the name of the trace source.

Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodShouldTraceDetermines whether the trace listener should trace the event. (Overrides TraceFilter::ShouldTrace(TraceEventCache, String, TraceEventType, Int32, String, array<Object>, Object, array<Object>).)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

One of several different types of filters can be assigned to a trace listener to provide a layer of screening beyond that provided by the trace switch. The filter can be used to control the level of tracing that is produced by the listener.

This class filters events based on a specific trace source set by the user.

SourceFilter overrides the ShouldTrace method and defines a Source property that specifies the name of the trace source to be traced by the listener.


This filter is provided because multiple trace sources can simultaneously use the same trace listener.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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

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