Export (0) Print
Expand All

TraceListener.Filter Property

Gets and sets the trace filter for the trace listener.

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

<ComVisibleAttribute(False)> _
Public Property Filter As TraceFilter

Property Value

Type: System.Diagnostics.TraceFilter
An object derived from the TraceFilter base class.

A trace filter can be added to a trace listener to provide a layer of screening beyond that provided to the trace source by switches. For example, the EventTypeFilter can be added to a trace listener to control the event types that are output by the listener. Listeners that are called because the switch criteria are met can query their filter, if present, to determine if a trace is to be sent to output.

The following code example shows how to use the Filter property to add a source filter to a console trace listener. This code example is part of a larger example provided for the TraceSource class.

' Test the filter on the ConsoleTraceListener.
ts.Listeners("console").Filter = New SourceFilter("No match")
ts.TraceData(TraceEventType.Error, 5, "SourceFilter should reject this message for the console trace listener.")
ts.Listeners("console").Filter = New SourceFilter("TraceTest")
ts.TraceData(TraceEventType.Error, 6, "SourceFilter should let this message through on the console trace listener.")

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

© 2014 Microsoft