TraceListener.Filter Property

public:
 property System::Diagnostics::TraceFilter ^ Filter { System::Diagnostics::TraceFilter ^ get(); void set(System::Diagnostics::TraceFilter ^ value); };

public System.Diagnostics.TraceFilter? Filter { get; set; }

public System.Diagnostics.TraceFilter Filter { get; set; }

[System.Runtime.InteropServices.ComVisible(false)]
public System.Diagnostics.TraceFilter Filter { get; set; }

member this.Filter : System.Diagnostics.TraceFilter with get, set

[<System.Runtime.InteropServices.ComVisible(false)>]
member this.Filter : System.Diagnostics.TraceFilter with get, set

Public Property Filter As TraceFilter

An object derived from the TraceFilter base class.

Attributes

ComVisibleAttribute

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

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

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.

• TraceListener
• DefaultTraceListener
• ConsoleTraceListener
• EventLogTraceListener
• TextWriterTraceListener
• Debug
• Trace