Trace.Write Method

Reference

Definition

Namespace:: System.Diagnostics

Assemblies:: netstandard.dll, System.Diagnostics.TraceSource.dll

Assembly:: System.Diagnostics.TraceSource.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 trace to the trace listeners in the Listeners collection.

Overloads

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

Write(Object)

Source:: Trace.cs

Source:: Trace.cs

Source:: Trace.cs

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

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

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

[System.Diagnostics.Conditional("TRACE")]
public static void Write(object value);

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

Public Shared Sub Write (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 the code sample.

If the switch is set to the TraceLevel Error or higher, the example outputs the first name of the value parameter 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 a message on the same line as the first message. The second message is followed by a line terminator.

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

public:
   static void MyErrorMethod( Object^ myObject )
   {
      #if defined(TRACE)
      // Write the message if the TraceSwitch level 
      // is set to Error or higher.
      if ( generalSwitch->TraceError )
      {
         Trace::Write( myObject );
      }
      
      // Write a second message if the TraceSwitch level
      // is set to Verbose.
      if ( generalSwitch->TraceVerbose )
      {
          Trace::WriteLine( " is not a valid value for this method." );
      }
      #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)
       Trace.Write(myObject);

    // Write a second message if the TraceSwitch level is set to Verbose.
    if(generalSwitch.TraceVerbose)
       Trace.WriteLine(" is not a valid value for this method.");
 }

' 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
        Trace.Write(myObject)
    End If 
    ' Write a second message if the TraceSwitch level is set to Verbose.
    If generalSwitch.TraceVerbose Then
        Trace.WriteLine(" is not a valid value for this method.")
    End If
End Sub

Remarks

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

This method calls the Write method of the trace listener.

Note

ASP.NET supplies tracing functionality tailored for Web pages. To write trace messages in ASP.NET pages, use the Page.Trace property.

By default, in code associated with an ASP.NET Web page, the statement Trace.Write("...") is a call to the Write method of the Page.Trace property. To use the System.Diagnostics.Trace class in Web pages, you must include the namespace, for example, System.Diagnostics.Trace.Write("...").

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	2.0, 2.1

Write(String)

Source:: Trace.cs

Source:: Trace.cs

Source:: Trace.cs

Writes a message to the trace listeners in the Listeners collection.

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

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

[System.Diagnostics.Conditional("TRACE")]
public static void Write(string message);

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

Public Shared Sub Write (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 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 on the same line as the first message. A line terminator follows the second message.

// Class-level declaration.
// Create a TraceSwitch.
private:
   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 )
      {
         Trace::Write( "My error message. " );
      }
      
      // Write a second message if the TraceSwitch level is set
      // to Verbose.
      if ( generalSwitch->TraceVerbose )
      {
          Trace::WriteLine( "My second error message." );
      }
   }

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

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

    // Write a second message if the TraceSwitch level is set to Verbose.
    if(generalSwitch.TraceVerbose)
       Trace.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
        Trace.Write("My error message. ")
    End If 
    ' Write a second message if the TraceSwitch level is set to Verbose.
    If generalSwitch.TraceVerbose Then
        Trace.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 Write method of the trace listener.

Note

ASP.NET supplies tracing functionality tailored for Web pages. To write trace messages in ASP.NET pages, use the Page.Trace property.

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	2.0, 2.1

Write(Object, String)

Source:: Trace.cs

Source:: Trace.cs

Source:: Trace.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 Write(System::Object ^ value, System::String ^ category);

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

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

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

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

Parameters

value: Object

An Object 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 the code sample.

If the switch is set to the TraceLevel Verbose, the example outputs the name of the myObject and the category to the Listeners. For information on adding a listener to the Listeners collection, see the TraceListenerCollection class.

Then, if the TraceLevel is set to Error or higher, 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.
private:
   static TraceSwitch^ generalSwitch = 
      gcnew TraceSwitch( "General", "Entire Application" );

public:
   static void MyErrorMethod( Object^ myObject, String^ category )
   {
      #if defined(TRACE)
      // Write the message if the TraceSwitch level is set to Verbose.
      if ( generalSwitch->TraceVerbose )
      {
         Trace::Write( myObject, category );
      }
      
      // Write a second message if the TraceSwitch level is set to 
      // Error or higher.
      if ( generalSwitch->TraceError )
      {
         Trace::WriteLine( " Object is not valid for this 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 Verbose.
    if(generalSwitch.TraceVerbose)
       Trace.Write(myObject, category);

    // Write a second message if the TraceSwitch level is set to Error or higher.
    if(generalSwitch.TraceError)
       Trace.WriteLine(" Object is not valid for this 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 Verbose.
    If generalSwitch.TraceVerbose Then
        Trace.Write(myObject, category)
    End If 
    ' Write a second message if the TraceSwitch level is set to Error or higher.
    If generalSwitch.TraceError Then
        Trace.WriteLine(" Object is not valid for this 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 Write method of the trace listener.

Note

ASP.NET supplies tracing functionality tailored for Web pages. To write trace messages in ASP.NET pages, use the Page.Trace property.

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	2.0, 2.1

Write(String, String)

Source:: Trace.cs

Source:: Trace.cs

Source:: Trace.cs

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

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

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

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

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

Public Shared Sub Write (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 the code sample.

If the switch is set to the TraceLevel Verbose, 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 Error or higher, 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.
private:
   static TraceSwitch^ generalSwitch = 
      gcnew TraceSwitch( "General", "Entire Application" );

public:
   static void MyErrorMethod( Object^ myObject, String^ category )
   {
      #if defined(TRACE)
      // Write the message if the TraceSwitch level is set to Verbose.
      if ( generalSwitch->TraceVerbose )
      {
         Trace::Write( String::Concat( myObject, 
            " is not a valid object for category: " ), category );
      }
      
      // Write a second message if the TraceSwitch level is set to
      // Error or higher.
      if ( generalSwitch->TraceError )
      {
         Trace::WriteLine( " Please use a different 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 Verbose.
    if(generalSwitch.TraceVerbose)
       Trace.Write(myObject.ToString() + " is not a valid object for category: ",
          category);

    // Write a second message if the TraceSwitch level is set to Error or higher.
    if(generalSwitch.TraceError)
       Trace.WriteLine(" Please use a different 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 Verbose.
    If generalSwitch.TraceVerbose Then
        Trace.Write(myObject.ToString() & _
            " is not a valid object for category: ", category)
    End If
    
    ' Write a second message if the TraceSwitch level is set to Error or higher.
    If generalSwitch.TraceError Then
        Trace.WriteLine(" Please use a different 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 Write method of the trace listener.

Note

ASP.NET supplies tracing functionality tailored for Web pages. To write trace messages in ASP.NET pages, use the Page.Trace property.

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	2.0, 2.1

Share via

Trace.Write Method

Definition

Overloads

Write(Object)

Parameters

Examples

Remarks

See also

Applies to

Write(String)

Parameters

Examples

Remarks

See also

Applies to

Write(Object, String)

Parameters

Examples

Remarks

See also

Applies to

Write(String, String)

Parameters

Examples

Remarks

See also

Applies to

Additional resources