ConsoleTraceListener Clase

Definición

public ref class ConsoleTraceListener : System::Diagnostics::TextWriterTraceListener

public class ConsoleTraceListener : System.Diagnostics.TextWriterTraceListener

type ConsoleTraceListener = class
    inherit TextWriterTraceListener

Public Class ConsoleTraceListener
Inherits TextWriterTraceListener

Herencia

Object

MarshalByRefObject

TraceListener

TextWriterTraceListener

ConsoleTraceListener

Ejemplos

En el ejemplo de código siguiente se implementa una aplicación de consola que consta de una clase con dos métodos públicos.

El Main método examina los argumentos de la línea de comandos y determina si la salida de seguimiento se debe dirigir al flujo de error estándar o al flujo de salida estándar. Main crea e inicializa un ConsoleTraceListener objeto para el flujo de salida especificado Console y agrega este objeto a la colección del agente de escucha de seguimiento. A continuación, llama al WriteEnvironmentInfoToTrace método , que escribe detalles sobre el entorno en ejecución y la configuración del agente de escucha de seguimiento en la salida de seguimiento.

Cuando se ejecuta la aplicación de ejemplo, los detalles de configuración de seguimiento y entorno se escriben en el flujo de salida de la consola especificada a través del ConsoleTraceListener objeto .

// Define the TRACE directive, which enables trace output to the
// Trace.Listeners collection. Typically, this directive is defined
// as a compilation argument.
#define TRACE
using System;
using System.Diagnostics;

public class ConsoleTraceSample
{

    // Define a simple method to write details about the current executing
    // environment to the trace listener collection.
    public static void WriteEnvironmentInfoToTrace()
    {

        string methodName = "WriteEnvironmentInfoToTrace";

        Trace.Indent();
        Trace.WriteLine(DateTime.Now.ToString() + " - Start of " + methodName);
        Trace.Indent();

        // Write details on the executing environment to the trace output.
        Trace.WriteLine("Operating system: " + System.Environment.OSVersion.ToString());
        Trace.WriteLine("Computer name: " + System.Environment.MachineName);
        Trace.WriteLine("User name: " + System.Environment.UserName);
        Trace.WriteLine("CLR runtime version: " + System.Environment.Version.ToString());
        Trace.WriteLine("Command line: " + System.Environment.CommandLine);

        // Enumerate the trace listener collection and
        // display details about each configured trace listener.
        Trace.WriteLine("Number of configured trace listeners = " + Trace.Listeners.Count.ToString());

        foreach (TraceListener tl in Trace.Listeners)
        {
            Trace.WriteLine("Trace listener name = " + tl.Name);
            Trace.WriteLine("               type = " + tl.GetType().ToString());
        }

        Trace.Unindent();
        Trace.WriteLine(DateTime.Now.ToString() + " - End of " + methodName);
        Trace.Unindent();
    }

    // Define the main entry point of this class.
    // The main method adds a console trace listener to the collection
    // of configured trace listeners, then writes details on the current
    // executing environment.
    public static void Main(string[] CmdArgs)
    {

        // Write a trace message to all configured trace listeners.
        Trace.WriteLine(DateTime.Now.ToString()+" - Start of Main");

        // Define a trace listener to direct trace output from this method
        // to the console.
        ConsoleTraceListener consoleTracer;

        // Check the command line arguments to determine which
        // console stream should be used for trace output.
        if ((CmdArgs.Length>0)&&(CmdArgs[0].ToString().ToLower().Equals("/stderr")))
            // Initialize the console trace listener to write
            // trace output to the standard error stream.
        {
            consoleTracer = new ConsoleTraceListener(true);
        }
        else
        {
            // Initialize the console trace listener to write
            // trace output to the standard output stream.
            consoleTracer = new ConsoleTraceListener();
        }
        // Set the name of the trace listener, which helps identify this
        // particular instance within the trace listener collection.
        consoleTracer.Name = "mainConsoleTracer";

        // Write the initial trace message to the console trace listener.
        consoleTracer.WriteLine(DateTime.Now.ToString()+" ["+consoleTracer.Name+"] - Starting output to trace listener.");

        // Add the new console trace listener to
        // the collection of trace listeners.
        Trace.Listeners.Add(consoleTracer);

        // Call a local method, which writes information about the current
        // execution environment to the configured trace listeners.
        WriteEnvironmentInfoToTrace();

        // Write the final trace message to the console trace listener.
        consoleTracer.WriteLine(DateTime.Now.ToString()+" ["+consoleTracer.Name+"] - Ending output to trace listener.");

        // Flush any pending trace messages, remove the
        // console trace listener from the collection,
        // and close the console trace listener.
        Trace.Flush();
        Trace.Listeners.Remove(consoleTracer);
        consoleTracer.Close();

        // Write a final trace message to all trace listeners.
        Trace.WriteLine(DateTime.Now.ToString()+" - End of Main");

        // Close all other configured trace listeners.
        Trace.Close();
    }
}

' Define the TRACE constant, which enables trace output to the 
' Trace.Listeners collection. Typically, this constant is defined
' as a compilation argument.
#Const TRACE = True

Imports System.Diagnostics

Public Class ConsoleTraceSample

    ' Define a simple method to write details about the current executing 
    ' environment to the trace listener collection.
    Public Shared Sub WriteEnvironmentInfoToTrace()

        Dim methodName As String = "WriteEnvironmentInfoToTrace"

        Trace.Indent()
        Trace.WriteLine(DateTime.Now.ToString() & " - Start of " & methodName)
        Trace.Indent()

        ' Write details on the executing environment to the trace output.
        Trace.WriteLine("Operating system: " & _
            System.Environment.OSVersion.ToString())
        Trace.WriteLine("Computer name: " & System.Environment.MachineName)
        Trace.WriteLine("User name: " & System.Environment.UserName)
        Trace.WriteLine("CLR version: " & System.Environment.Version.ToString)
        Trace.WriteLine("Command line: " & System.Environment.CommandLine)

        ' Enumerate the trace listener collection and 
        ' display details about each configured trace listener.
        Trace.WriteLine("Number of configured trace listeners = " & _
            Trace.Listeners.Count.ToString())

        Dim tl As TraceListener
        For Each tl In Trace.Listeners
            Trace.WriteLine("Trace listener name = " & tl.Name)
            Trace.WriteLine("               type = " & tl.GetType().ToString())
        Next tl

        Trace.Unindent()
        Trace.WriteLine(DateTime.Now.ToString() & " - End of " & methodName)
        Trace.Unindent()

    End Sub

    ' Define the main entry point of this class.
    ' The main method adds a console trace listener to the collection
    ' of configured trace listeners, then writes details on the current
    ' executing environment.
    Public Shared Sub Main(ByVal CmdArgs() As String)

        ' Write a trace message to all configured trace listeners.
        Trace.WriteLine(DateTime.Now.ToString() & " - Start of Main")

        ' Define a trace listener to direct trace output from this method
        ' to the console.
        Dim consoleTracer As ConsoleTraceListener

        ' Check the command line arguments to determine which
        ' console stream should be used for trace output.
        If (CmdArgs.Length > 0) AndAlso _
           (CmdArgs(0).ToLower.Equals("/stderr")) Then
            ' Initialize the console trace listener to write
            ' trace output to the standard error stream.
            consoleTracer = New ConsoleTraceListener(True)
        Else
            ' Initialize the console trace listener to write
            ' trace output to the standard output stream.
            consoleTracer = New ConsoleTraceListener
        End If
        ' Set the name of the trace listener, which helps identify this 
        ' particular instance within the trace listener collection.
        consoleTracer.Name = "mainConsoleTracer"

        ' Write the initial trace message to the console trace listener.
        consoleTracer.WriteLine(DateTime.Now.ToString() & " [" & _
             consoleTracer.Name & "] - Starting output to trace listener.")

        ' Add the new console trace listener to 
        ' the collection of trace listeners.
        Trace.Listeners.Add(consoleTracer)

        ' Call a local method, which writes information about the current 
        ' execution environment to the configured trace listeners.
        WriteEnvironmentInfoToTrace()

        ' Write the final trace message to the console trace listener.
        consoleTracer.WriteLine(DateTime.Now.ToString() & " [" & _
            consoleTracer.Name & "] - Ending output to trace listener.")

        ' Flush any pending trace messages, remove the 
        ' console trace listener from the collection,
        ' and close the console trace listener.
        Trace.Flush()
        Trace.Listeners.Remove(consoleTracer)
        consoleTracer.Close()

        ' Write a final trace message to all trace listeners.
        Trace.WriteLine(DateTime.Now.ToString() + " - End of Main")

        ' Close all other configured trace listeners.
        Trace.Close()

    End Sub

End Class

Comentarios

Use la ConsoleTraceListener clase para escribir mensajes de seguimiento y depuración en la consola. Puede inicializar un ConsoleTraceListener objeto para escribir mensajes de seguimiento en la Console.Out secuencia o en la Console.Error secuencia.

Cuando la salida de seguimiento y depuración está habilitada, los ConsoleTraceListener mensajes se escriben en la secuencia especificada System.Console , que es similar a la forma en que los mensajes se escriben con los Console.Write métodos o Console.WriteLine . En una aplicación de consola, los System.Console flujos de salida y error escriben mensajes en la ventana de consola existente, o bien puede redirigir las secuencias para escribir en una System.IO.TextWriter instancia de .

Agregue un ConsoleTraceListener objeto a la colección adecuada Listeners si desea que los mensajes escritos a través Tracede , TraceSourceo Debug se escriban en la consola. Además, puede escribir mensajes directamente en la consola mediante los Trace.Write métodos o Trace.WriteLine .

La mayoría de los compiladores habilitan la salida de seguimiento y depuración a través de marcas de compilación condicionales. Si no habilita el seguimiento o la depuración, los mensajes escritos a través de las System.Diagnostics.Debug clases y System.Diagnostics.Trace se omiten de forma eficaz. La sintaxis para habilitar la salida de seguimiento y depuración es específica del compilador; Si usa compiladores distintos de C# o Visual Basic, consulte la documentación del compilador.

• Para habilitar la depuración en C#, agregue la marca /d:DEBUGa la línea de comandos del compilador al compilar el código, o bien puede agregar #define DEBUG a la parte superior del archivo. En Visual Basic, agregue la marca /d:DEBUG=True a la línea de comandos del compilador.

• Para habilitar el seguimiento en C#, agregue la marca /d:TRACE a la línea de comandos del compilador al compilar el código o agregue #define TRACE a la parte superior del archivo. En Visual Basic, agregue la marca /d:TRACE=True a la línea de comandos del compilador.

Puede agregar un ConsoleTraceListener objeto a la colección en el Listeners código. O bien, para las aplicaciones de .NET Framework, puede agregar un ConsoleTraceListener objeto a la Listeners colección a través del archivo de configuración de la aplicación. Agregue el objeto en el ConsoleTraceListener código para escribir mensajes para una sección de código específica o una ruta de acceso de ejecución. Agregue el objeto en el ConsoleTraceListener archivo de configuración de la aplicación para dirigir todos los mensajes de seguimiento y depuración a la consola mientras se ejecuta la aplicación.

Para escribir mensajes de seguimiento y depuración en la consola para una sección específica de código, inicialice un ConsoleTraceListener objeto y agréguelo a la Listeners colección. Instrumente la sección de código que contiene mensajes mediante las Trace clases o Debug . Al final de la sección de código, quite el ConsoleTraceListener objeto de la Listeners colección y llame al Close método en .ConsoleTraceListener

En el caso de las aplicaciones de .NET Framework, para dirigir todos los mensajes de seguimiento y depuración a la consola mientras se ejecuta la aplicación, agregue un ConsoleTraceListener objeto al archivo de configuración de la aplicación. En el ejemplo siguiente se agrega un ConsoleTraceListener objeto denominado configConsoleListener a la Listeners colección .

<configuration>  
  <system.diagnostics>  
    <trace autoflush="false" indentsize="4">  
      <listeners>  
        <add name="configConsoleListener" type="System.Diagnostics.ConsoleTraceListener" />  
      </listeners>  
    </trace>  
  </system.diagnostics>  
 </configuration>  

Para más información sobre cómo agregar agentes de escucha de seguimiento en el archivo de configuración de la aplicación, consulte <agentes de> escucha.

Constructores

Propiedades

Métodos

Se aplica a

Consulte también

• TraceListener
• TextWriterTraceListener
• Debug
• Trace
• Console