Click to Rate and Give Feedback
MSDN
MSDN Library
.NET Development
.NET Framework 3.5
Debug Class
Debug Properties
 Listeners Property
Collapse All/Expand All Collapse All
This page is specific to
Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:
.NET Framework Class Library
Debug..::.Listeners Property

Updated: September 2008

Gets the collection of listeners that is monitoring the debug output.

Namespace:  System.Diagnostics
Assembly:  System (in System.dll)
Visual Basic (Declaration)
Public Shared ReadOnly Property Listeners As TraceListenerCollection
Visual Basic (Usage)
Dim value As TraceListenerCollection

value = Debug.Listeners
C#
public static TraceListenerCollection Listeners { get; }
Visual C++
public:
static property TraceListenerCollection^ Listeners {
    TraceListenerCollection^ get ();
}
JScript
public static function get Listeners () : TraceListenerCollection

Property Value

Type: System.Diagnostics..::.TraceListenerCollection
A TraceListenerCollection representing a collection of type TraceListener that monitors the debug output.

The listeners produce formatted output from the debug output. By default, the collection contains an instance of the DefaultTraceListener class. To remove the default listener, call the Remove method, and pass it the instance of the DefaultTraceListener. To redirect output to the console window, add an instance of the ConsoleTraceListener. To redirect output to a file or stream, add an instance of the TextWriterTraceListener.

NoteNote:

The Listeners collection is shared by both the Debug and the Trace classes; adding a trace listener to either class adds the listener to both.

The following example creates a TextWriterTraceListener that outputs to the console screen. The code then adds the new listener to the Listeners.

Visual Basic
' Create a listener that outputs to the console screen, and 
' add it to the debug listeners. 
Dim myWriter As New TextWriterTraceListener(System.Console.Out)
Debug.Listeners.Add(myWriter)
C#
/* Create a listener that outputs to the console screen, and 
  * add it to the debug listeners. */
 TextWriterTraceListener myWriter = new 
    TextWriterTraceListener(System.Console.Out);
 Debug.Listeners.Add(myWriter);

Visual C++
// Create a listener that outputs to the console screen 
// and add it to the debug listeners.
#if defined(DEBUG)
TextWriterTraceListener^ myWriter = 
   gcnew TextWriterTraceListener( System::Console::Out );
Debug::Listeners->Add( myWriter );
#endif

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

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

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0

XNA Framework

Supported in: 3.0, 2.0, 1.0

Date

History

Reason

September 2008

Added a note about the Listeners collection being shared with Trace.

Customer feedback.

Tags What's this?: Add a tag
Community Content   What is Community Content?
Add new content RSS  Annotations
Processing
© 2010 Microsoft Corporation. All rights reserved. Terms of Use | Trademarks | Privacy Statement
Page view tracker