This documentation is archived and is not being maintained.

TraceListener.Filter Property

Note: This property is new in the .NET Framework version 2.0.

Gets and sets the trace filter for the trace listener.

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

[ComVisibleAttribute(false)] 
public TraceFilter Filter { get; set; }
/** @property */
public TraceFilter get_Filter ()

/** @property */
public void set_Filter (TraceFilter value)

public function get Filter () : TraceFilter

public function set Filter (value : TraceFilter)

Property Value

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.");

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

.NET Framework

Supported in: 2.0
Show: