Debug.WriteLine Method (String, Object[]) (System.Diagnostics)

Switch View :

Classic

Lightweight

ScriptFree

Site Feedback

.NET Framework Class Library

Debug.WriteLine Method (String, Object[])

Updated: January 2012

Writes a formatted message followed by a line terminator to the trace listeners in the Listeners collection.

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

Syntax

Visual Basic

<ConditionalAttribute("DEBUG")> _
Public Shared Sub WriteLine ( _
	format As String, _
	ParamArray args As Object() _
)

[ConditionalAttribute("DEBUG")]
public static void WriteLine(
	string format,
	params Object[] args
)

Visual C++

[ConditionalAttribute(L"DEBUG")]
public:
static void WriteLine(
	String^ format, 
	... array<Object^>^ args
)

[<ConditionalAttribute("DEBUG")>]
static member WriteLine : 
        format:string * 
        args:Object[] -> unit

Parameters

format: Type: System.String
A composite format string (see Remarks) that contains text intermixed with zero or more format items, which correspond to objects in the args array.

args: Type: System.Object[]
An object array containing zero or more objects to format.

Remarks

This method uses the composite formatting feature of the .NET Framework to convert the value of an object to its text representation and embed that representation in a string.

The params [.NET Framework] keyword in the syntax for this method implies that the object array can be a single value. The exception to this is the String object. Explicit overloads take precedence, so an arg value of a single string will default to the Debug.WriteLine(String, String) overload.

By default, the output is written to an instance of DefaultTraceListener.

This method calls the TraceListener.WriteLine method of the trace listener.

Version Information

.NET Framework

Supported in: 4

.NET Framework Client Profile

Supported in: 4

Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, 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.

Reference

Debug Class

WriteLine Overload

System.Diagnostics Namespace

Change History

Date	History	Reason
January 2012	Added information about the behavior when the array is a single string.	Customer feedback.

Date

History

Reason

January 2012

Added information about the behavior when the array is a single string.

Customer feedback.

Community Content

AdrianJMartin

Gotcha with this Override

There's a 'gotcha' with this method: If you pass a format string and a single parameter of type string, then it will resolve to a different method override... string key ="key" ;Debug.WriteLine( "key:{0}" , key ); outputs: key: key:{0} you can work around it by adding an extra parameter Debug.WriteLine( "key:{0}" , key , 0);