ConsoleTraceListener Classe

Definição

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

public class ConsoleTraceListener : System.Diagnostics.TextWriterTraceListener

type ConsoleTraceListener = class
    inherit TextWriterTraceListener

Public Class ConsoleTraceListener
Inherits TextWriterTraceListener

Herança

Object

MarshalByRefObject

TraceListener

TextWriterTraceListener

ConsoleTraceListener

Exemplos

O exemplo de código a seguir implementa um aplicativo de console que consiste em uma classe com dois métodos públicos.

O Main método examina os argumentos de linha de comando e determina se a saída de rastreamento deve ser direcionada para o fluxo de erro padrão ou o fluxo de saída padrão. Main cria e inicializa um ConsoleTraceListener objeto para o fluxo de saída especificado Console e adiciona esse objeto à coleção de ouvintes de rastreamento. Em seguida, ele chama o WriteEnvironmentInfoToTrace método, que grava detalhes sobre o ambiente em execução e a configuração do ouvinte de rastreamento na saída do rastreamento.

Quando o aplicativo de exemplo é executado, os detalhes de configuração de ambiente e rastreamento são gravados no fluxo de saída do console especificado por meio do 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

Comentários

Use a ConsoleTraceListener classe para gravar mensagens de rastreamento e depuração no console. Você pode inicializar um ConsoleTraceListener objeto para gravar mensagens de rastreamento no Console.Out fluxo ou no Console.Error fluxo.

Quando a saída de rastreamento e depuração é habilitada, as ConsoleTraceListener mensagens são gravadas no fluxo especificadoSystem.Console, que é semelhante à maneira como as mensagens são escritas com os métodos ou Console.WriteLine os Console.Write métodos. Em um aplicativo de console, a saída e o System.Console erro transmitem mensagens de gravação para a janela do console existente ou você pode redirecionar os fluxos para gravar em uma System.IO.TextWriter instância.

Adicione um ConsoleTraceListener objeto à coleção apropriada Listeners se desejar que as mensagens sejam gravadas por meio TraceTraceSourceou Debug gravadas no console. Além disso, você pode escrever mensagens diretamente no console usando os métodos ou Trace.WriteLine os Trace.Write métodos.

A maioria dos compiladores habilita a saída de rastreamento e depuração por meio de sinalizadores de compilação condicional. Se você não habilitar o rastreamento ou a depuração, as mensagens escritas por meio do e System.Diagnostics.Trace das System.Diagnostics.Debug classes serão efetivamente ignoradas. A sintaxe para habilitar a saída de rastreamento e depuração é específica do compilador; se você usar compiladores diferentes de C# ou Visual Basic, consulte a documentação do compilador.

• Para habilitar a depuração em C#, adicione o sinalizador /d:DEBUGà linha de comando do compilador ao compilar seu código ou adicione #define DEBUG à parte superior do arquivo. Em Visual Basic, adicione o sinalizador /d:DEBUG=True à linha de comando do compilador.

• Para habilitar o rastreamento em C#, adicione o sinalizador /d:TRACE à linha de comando do compilador ao compilar seu código ou adicione #define TRACE à parte superior do arquivo. Em Visual Basic, adicione o sinalizador /d:TRACE=True à linha de comando do compilador.

Você pode adicionar um ConsoleTraceListener objeto à Listeners coleção em seu código. Ou, para aplicativos .NET Framework, você pode adicionar um objeto ConsoleTraceListener à coleção Listeners por meio do arquivo de configuração do aplicativo. Adicione o ConsoleTraceListener objeto em seu código para gravar mensagens para uma seção de código específica ou caminho de execução. Adicione o ConsoleTraceListener objeto no arquivo de configuração do aplicativo para direcionar todas as mensagens de rastreamento e depuração para o console enquanto o aplicativo é executado.

Para gravar mensagens de rastreamento e depuração no console para uma seção específica do código, inicialize um ConsoleTraceListener objeto e adicione-o Listeners à coleção. Instrumente a seção de código que contém mensagens usando as classes ou Debug as Trace classes. No final da seção de código, remova o ConsoleTraceListener objeto da Listeners coleção e chame o Close método no ConsoleTraceListener.

Para aplicativos .NET Framework, para direcionar todas as mensagens de rastreamento e depuração para o console enquanto o aplicativo é executado, adicione um objeto ConsoleTraceListener ao arquivo de configuração do aplicativo. O exemplo a seguir adiciona um ConsoleTraceListener objeto nomeado configConsoleListener à Listeners coleção.

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

Para obter detalhes sobre como adicionar ouvintes de rastreamento no arquivo de configuração do aplicativo, consulte <os ouvintes>.

Confira também

• TraceListener
• TextWriterTraceListener
• Debug
• Trace
• Console