Debug.WriteLine Method

Reference

Definition

Namespace:: System.Diagnostics

Assemblies:: System.dll, System.Diagnostics.Debug.dll

Assemblies:: netstandard.dll, System.Runtime.dll

Assembly:: System.Diagnostics.Debug.dll

Assembly:: System.dll

Assembly:: netstandard.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Writes information about the debug to the trace listeners in the Listeners collection.

Overloads

WriteLine(String, String)	Writes a category name and message to the trace listeners in the Listeners collection.
WriteLine(String, Object[])	Writes a formatted message followed by a line terminator to the trace listeners in the Listeners collection.
WriteLine(String)	Writes a message followed by a line terminator to the trace listeners in the Listeners collection.
WriteLine(Object)	Writes the value of the object's ToString() method to the trace listeners in the Listeners collection.
WriteLine(Object, String)	Writes a category name and the value of the object's ToString() method to the trace listeners in the Listeners collection.

WriteLine(String, String)

Source:: Debug.cs

Source:: Debug.cs

Source:: Debug.cs

Writes a category name and message to the trace listeners in the Listeners collection.

public:
 static void WriteLine(System::String ^ message, System::String ^ category);

[System.Diagnostics.Conditional("DEBUG")]
public static void WriteLine(string message, string category);

[System.Diagnostics.Conditional("DEBUG")]
public static void WriteLine(string? message, string? category);

[<System.Diagnostics.Conditional("DEBUG")>]
static member WriteLine : string * string -> unit

Public Shared Sub WriteLine (message As String, category As String)

Parameters

message: String

A message to write.

category: String

A category name used to organize the output.

Attributes: ConditionalAttribute

Examples

The following example creates a TraceSwitch named generalSwitch. This switch is set outside of the code sample.

If the switch is set to the TraceLevel Error or higher, the example outputs the first error message to the Listeners. For information on adding a listener to the Listeners collection, see the TraceListenerCollection class.

Then, if the TraceLevel is set to Verbose, the example outputs the second error message and the category on the same line as the first message. A line terminator follows the second message.

   // Class-level declaration.
   // Create a TraceSwitch.
   static TraceSwitch^ generalSwitch = 
      gcnew TraceSwitch( "General","Entire Application" );

public:
   static void MyErrorMethod( String^ category )
   {
      // Write the message if the TraceSwitch level is set to Error or higher.
      if ( generalSwitch->TraceError )
      {
         #if defined(DEBUG)
         Debug::Write( "My error message. " );
         #endif
      }
      // Write a second message if the TraceSwitch level is set to Verbose.
      if ( generalSwitch->TraceVerbose )
      {
         #if defined(DEBUG)
         Debug::WriteLine( "My second error message.", category );
         #endif
      }
   }

// Class-level declaration.
// Create a TraceSwitch.
static TraceSwitch generalSwitch = new TraceSwitch("General", "Entire Application");

static public void MyErrorMethod(string category)
{
    // Write the message if the TraceSwitch level is set to Error or higher.
    if (generalSwitch.TraceError)
        Debug.Write("My error message. ");

    // Write a second message if the TraceSwitch level is set to Verbose.
    if (generalSwitch.TraceVerbose)
        Debug.WriteLine("My second error message.", category);
}

' Class-level declaration.
' Create a TraceSwitch.
Private Shared generalSwitch As New TraceSwitch("General", "Entire Application")


Public Shared Sub MyErrorMethod(category As String)
    ' Write the message if the TraceSwitch level is set to Error or higher.
    If generalSwitch.TraceError Then
        Debug.Write("My error message. ")
    End If 
    ' Write a second message if the TraceSwitch level is set to Verbose.
    If generalSwitch.TraceVerbose Then
        Debug.WriteLine("My second error message.", category)
    End If
End Sub

Remarks

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

The category parameter can be used to group output messages.

This method calls the WriteLine method of the trace listener.

Applies to

.NET 10 and other versions

Product	Versions
.NET	Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10
.NET Framework	1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard	1.3, 1.4, 1.6, 2.0, 2.1
UWP	10.0

WriteLine(String, Object[])

Source:: Debug.cs

Source:: Debug.cs

Source:: Debug.cs

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

public:
 static void WriteLine(System::String ^ format, ... cli::array <System::Object ^> ^ args);

[System.Diagnostics.Conditional("DEBUG")]
public static void WriteLine(string format, params object[] args);

[System.Diagnostics.Conditional("DEBUG")]
public static void WriteLine(string format, params object?[] args);

[<System.Diagnostics.Conditional("DEBUG")>]
static member WriteLine : string * obj[] -> unit

Public Shared Sub WriteLine (format As String, ParamArray args As Object())

Parameters

format: String

A composite format string that contains text intermixed with zero or more format items, which correspond to objects in the args array.

args: Object[]

An object array that contains zero or more objects to format.

Attributes: ConditionalAttribute

Remarks

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

The params (in C#) or ParamArray (in Visual Basic) 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.

Applies to

.NET 10 and other versions

Product	Versions
.NET	Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10
.NET Framework	4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard	1.0, 1.1, 1.2, 1.3, 1.4, 1.6, 2.0, 2.1
UWP	10.0

WriteLine(String)

Source:: Debug.cs

Source:: Debug.cs

Source:: Debug.cs

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

public:
 static void WriteLine(System::String ^ message);

[System.Diagnostics.Conditional("DEBUG")]
public static void WriteLine(string message);

[System.Diagnostics.Conditional("DEBUG")]
public static void WriteLine(string? message);

[<System.Diagnostics.Conditional("DEBUG")>]
static member WriteLine : string -> unit

Public Shared Sub WriteLine (message As String)

Parameters

message: String

A message to write.

Attributes: ConditionalAttribute

Examples

The following example creates a TraceSwitch named generalSwitch. This switch is set outside of the code sample.

Then, if the TraceLevel is set to Verbose, the example outputs the second error message on the same line as the first message. A line terminator follows the second message.

   // Class-level declaration.
   // Create a TraceSwitch.
   static TraceSwitch^ generalSwitch = 
      gcnew TraceSwitch( "General","Entire Application" );

public:
   static void MyErrorMethod()
   {
      // Write the message if the TraceSwitch level is set to Error or higher.
      if ( generalSwitch->TraceError )
      {
         #if defined(DEBUG)
         Debug::Write( "My error message. " );
         #endif
      }
      // Write a second message if the TraceSwitch level is set to Verbose.
      if ( generalSwitch->TraceVerbose )
      {
         #if defined(DEBUG)
         Debug::WriteLine( "My second error message." );
         #endif
      }
   }

// Class-level declaration.
// Create a TraceSwitch.
TraceSwitch generalSwitch = new TraceSwitch("General", "Entire Application");

static void MyErrorMethod()
{
    // Write the message if the TraceSwitch level is set to Error or higher.
    if (generalSwitch.TraceError)
        Debug.Write("My error message. ");

    // Write a second message if the TraceSwitch level is set to Verbose.
    if (generalSwitch.TraceVerbose)
        Debug.WriteLine("My second error message.");
}

' Class-level declaration.
' Create a TraceSwitch.
Private Shared generalSwitch As New TraceSwitch("General", "Entire Application")


Public Shared Sub MyErrorMethod()
    ' Write the message if the TraceSwitch level is set to Error or higher.
    If generalSwitch.TraceError Then
        Debug.Write("My error message. ")
    End If 
    ' Write a second message if the TraceSwitch level is set to Verbose.
    If generalSwitch.TraceVerbose Then
        Debug.WriteLine("My second error message.")
    End If
End Sub

Remarks

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

This method calls the WriteLine method of the trace listener.

Applies to

.NET 10 and other versions

Product	Versions
.NET	Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10
.NET Framework	1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard	1.0, 1.1, 1.2, 1.3, 1.4, 1.6, 2.0, 2.1
UWP	10.0

WriteLine(Object)

Source:: Debug.cs

Source:: Debug.cs

Source:: Debug.cs

Writes the value of the object's ToString() method to the trace listeners in the Listeners collection.

public:
 static void WriteLine(System::Object ^ value);

[System.Diagnostics.Conditional("DEBUG")]
public static void WriteLine(object value);

[System.Diagnostics.Conditional("DEBUG")]
public static void WriteLine(object? value);

[<System.Diagnostics.Conditional("DEBUG")>]
static member WriteLine : obj -> unit

Public Shared Sub WriteLine (value As Object)

Parameters

value: Object

An object whose name is sent to the Listeners.

Attributes: ConditionalAttribute

Examples

The following example creates a TraceSwitch named generalSwitch. This switch is set outside of the code sample.

Then, if the TraceLevel is set to Verbose, the example outputs the name of the object on the same line as the first message. A line terminator follows the second message.

   // Class-level declaration.
   // Create a TraceSwitch.
   static TraceSwitch^ generalSwitch = 
      gcnew TraceSwitch( "General","Entire Application" );

public:
   static void MyErrorMethod( Object^ myObject )
   {
      // Write the message if the TraceSwitch level is set to Error or higher.
      if ( generalSwitch->TraceError )
      {
         #if defined(DEBUG)
         Debug::Write( "Invalid object. " );
         #endif
      }
      // Write a second message if the TraceSwitch level is set to Verbose.
      if ( generalSwitch->TraceVerbose )
      {
         #if defined(DEBUG)
         Debug::WriteLine( myObject );
         #endif
      }
   }

// Class-level declaration.
// Create a TraceSwitch.
static TraceSwitch generalSwitch = new TraceSwitch("General", "Entire Application");

static public void MyErrorMethod(Object myObject)
{
    // Write the message if the TraceSwitch level is set to Error or higher.
    if (generalSwitch.TraceError)
        Debug.Write("Invalid object. ");

    // Write a second message if the TraceSwitch level is set to Verbose.
    if (generalSwitch.TraceVerbose)
        Debug.WriteLine(myObject);
}

' Class-level declaration.
' Create a TraceSwitch.
Private Shared generalSwitch As New TraceSwitch("General", "Entire Application")


Public Shared Sub MyErrorMethod(myObject As Object)
    ' Write the message if the TraceSwitch level is set to Error or higher.
    If generalSwitch.TraceError Then
        Debug.Write("Invalid object. ")
    End If 
    ' Write a second message if the TraceSwitch level is set to Verbose.
    If generalSwitch.TraceVerbose Then
        Debug.WriteLine(myObject)
    End If
End Sub

Remarks

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

This method calls the WriteLine method of the trace listener.

Applies to

.NET 10 and other versions

Product	Versions
.NET	Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10
.NET Framework	1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard	1.0, 1.1, 1.2, 1.3, 1.4, 1.6, 2.0, 2.1
UWP	10.0

WriteLine(Object, String)

Source:: Debug.cs

Source:: Debug.cs

Source:: Debug.cs

Writes a category name and the value of the object's ToString() method to the trace listeners in the Listeners collection.

public:
 static void WriteLine(System::Object ^ value, System::String ^ category);

[System.Diagnostics.Conditional("DEBUG")]
public static void WriteLine(object value, string category);

[System.Diagnostics.Conditional("DEBUG")]
public static void WriteLine(object? value, string? category);

[<System.Diagnostics.Conditional("DEBUG")>]
static member WriteLine : obj * string -> unit

Public Shared Sub WriteLine (value As Object, category As String)

Parameters

value: Object

An object whose name is sent to the Listeners.

category: String

A category name used to organize the output.

Attributes: ConditionalAttribute

Examples

The following example creates a TraceSwitch named generalSwitch. This switch is set outside of the code sample.

Then, if the TraceLevel is set to Verbose, the example outputs the second error message on the same line as the first message. The second message is followed by a line terminator.

   // Class-level declaration.
   // Create a TraceSwitch.
   static TraceSwitch^ generalSwitch = 
      gcnew TraceSwitch( "General","Entire Application" );

public:
   static void MyErrorMethod( Object^ myObject, String^ category )
   {
      // Write the message if the TraceSwitch level is set to Error or higher.
      if ( generalSwitch->TraceError )
      {
         #if defined(DEBUG)
         Debug::Write( "Invalid object for category. " );
         #endif
      }
      // Write a second message if the TraceSwitch level is set to Verbose.
      if ( generalSwitch->TraceVerbose )
      {
         #if defined(DEBUG)
         Debug::WriteLine( myObject, category );
         #endif
      }
   }

// Class-level declaration.
// Create a TraceSwitch.
static TraceSwitch generalSwitch = new TraceSwitch("General", "Entire Application");

static public void MyErrorMethod(Object myObject, string category)
{
    // Write the message if the TraceSwitch level is set to Error or higher.
    if (generalSwitch.TraceError)
        Debug.Write("Invalid object for category. ");

    // Write a second message if the TraceSwitch level is set to Verbose.
    if (generalSwitch.TraceVerbose)
        Debug.WriteLine(myObject, category);
}

' Class-level declaration.
' Create a TraceSwitch.
Private Shared generalSwitch As New TraceSwitch("General", "Entire Application")


Public Shared Sub MyErrorMethod(myObject As Object, category As String)
    ' Write the message if the TraceSwitch level is set to Error or higher.
    If generalSwitch.TraceError Then
        Debug.Write("Invalid object for category. ")
    End If 
    ' Write a second message if the TraceSwitch level is set to Verbose.
    If generalSwitch.TraceVerbose Then
        Debug.WriteLine(myObject, category)
    End If
End Sub

Remarks

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

The category parameter can be used to group output messages.

This method calls the WriteLine method of the trace listener.

Applies to

.NET 10 and other versions

Product	Versions
.NET	Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10
.NET Framework	1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard	1.3, 1.4, 1.6, 2.0, 2.1
UWP	10.0

Share via

Debug.WriteLine Method

Definition

Overloads

WriteLine(String, String)

Parameters

Examples

Remarks

See also

Applies to

WriteLine(String, Object[])

Parameters

Remarks

Applies to

WriteLine(String)

Parameters

Examples

Remarks

See also

Applies to

WriteLine(Object)

Parameters

Examples

Remarks

See also

Applies to

WriteLine(Object, String)

Parameters

Examples

Remarks

See also

Applies to

Additional resources