Export (0) Print
Expand All

TraceFilter Class

Provides the base class for trace filter implementations.

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

'Declaration
Public MustInherit Class TraceFilter

The TraceFilter type exposes the following members.

  NameDescription
Protected methodTraceFilterInitializes a new instance of the TraceFilter class.
Top

  NameDescription
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 methodShouldTraceWhen overridden in a derived class, determines whether the trace listener should trace the event.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

Trace filters can be used by trace listeners to provide an extra layer of filtering beyond that provided by trace switches. The trace filter for a trace listener can be found in the listener's Filter property. Trace switches determine if a trace is to be sent to the trace listeners. Trace filters allow the individual trace listeners to determine whether or not the trace is to be written to the associated output medium. For example, as determined by each trace filter, a trace may be written to the console by a ConsoleTraceListener, but not to the event log by a EventLogTraceListener.

Filters that inherit from the TraceFilter class can be used by trace listeners that inherit from the TraceListener class to perform filtering of events being traced. TraceFilter contains a single method, ShouldTrace, which takes event data and returns a flag indicating whether the event should be traced.

.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.

Community Additions

ADD
Show:
© 2014 Microsoft