ConsoleTraceListener, classe

Utilisez la classe ConsoleTraceListener pour écrire les messages de trace et de débogage dans la console. Vous pouvez initialiser un objet ConsoleTraceListener pour écrire des messages de trace dans le flux Console.Out ou le flux Console.Error.

Lorsque la sortie de trace et de débogage est activée, les messages ConsoleTraceListener sont écrits dans le flux System.Console spécifié, ce qui correspond à la manière dont les messages sont écrits avec les méthodes Console.Write ou Console.WriteLine. Dans une application console, les flux de sortie et d'erreurs System.Console écrivent des messages dans la fenêtre de console existante, ou vous pouvez rediriger les flux pour écrire dans une instance de System.IO.TextWriter.

Remarque
Si la console n'existe pas, par exemple dans une application Windows, les messages écrits dans la console ne sont pas affichés.

Ajoutez un objet ConsoleTraceListener à la collection Listeners appropriée si vous souhaitez des messages écrits via Trace, TraceSource ou que Debug soit écrit dans la console. De plus, vous pouvez écrire directement des messages dans la console à l'aide des méthodes Trace.Write ou Trace.WriteLine.

Remarque
Les classes Debug et Trace partagent la même collection TraceListenerCollection accessible via leurs propriétés Listeners respectives. Si vous ajoutez un objet ConsoleTraceListener à la collection qui utilise l'une de ces classes, l'autre classe utilise automatiquement le même écouteur.

La plupart des compilateurs activent la sortie de trace et de débogage via des indicateurs de compilation conditionnels. Si vous n'activez pas le traçage ou le débogage, les messages écrits via les classes System.Diagnostics.Debug et System.Diagnostics.Trace sont effectivement ignorés. La syntaxe pour activer la sortie de trace et de débogage est spécifique au compilateur ; si vous utilisez des compilateurs autres que C# ou Visual Basic, reportez-vous à la documentation pour votre compilateur.

• Pour activer le débogage en C#, ajoutez l'indicateur /d:DEBUG à la ligne de commande du compilateur lors de la compilation du code, ou ajoutez #define DEBUG au début du fichier. En Visual Basic, ajoutez l'indicateur /d:DEBUG=True à la ligne de commande du compilateur.

• Pour activer le traçage en C#, ajoutez l'indicateur /d:TRACE à la ligne de commande du compilateur lors de la compilation du code ou ajoutez #define TRACE au début du fichier. En Visual Basic, ajoutez l'indicateur /d:TRACE=True à la ligne de commande du compilateur.

Vous pouvez ajouter un objet ConsoleTraceListener à la collection Listeners dans votre code, ou vous pouvez ajouter un objet ConsoleTraceListener à la collection Listeners via le fichier de configuration de l'application. Ajoutez l'objet ConsoleTraceListener dans votre code pour écrire des messages pour une section de code ou un chemin d'exécution spécifique. Ajoutez l'objet ConsoleTraceListener dans votre fichier de configuration de l'application pour diriger tous les messages de trace et de débogage vers la console lors de l'exécution de l'application.

Pour écrire les messages de trace et de débogage dans la console pour une section spécifique de code, initialisez un objet ConsoleTraceListener et ajoutez-le à la collection Listeners. Instrumentez la section de code qui contient des messages à l'aide des classes Trace ou Debug. À la fin de la section de code, supprimez l'objet ConsoleTraceListener de la collection Listeners et appelez la méthode Close sur ConsoleTraceListener.

Pour diriger tous les messages de trace et de débogage vers la console au cours de l'exécution de l'application, ajoutez un objet ConsoleTraceListener au fichier de configuration de l'application. Modifiez le fichier de configuration qui correspond au nom de votre application, ou le fichier app.config dans un projet Visual Studio 2005. Dans ce fichier, insérez un élément pour ConsoleTraceListener.

L'exemple suivant ajoute un objet ConsoleTraceListener nommé configConsoleListener à la collection Listeners.

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

Pour plus d'informations sur l'ajout des écouteurs de la trace dans le fichier de configuration de l'application, consultez <listeners>, élément de <trace>.

Remarque

L'attribut HostProtectionAttribute appliqué à ce type ou membre a la valeur de propriété Resources suivante : Synchronization. HostProtectionAttribute n'affecte pas les applications bureautiques (qui sont généralement démarrées en double-cliquant sur une icône, en tapant une commande ou en entrant une URL dans un navigateur). Pour plus d'informations, consultez la classe HostProtectionAttribute ou Attributs de programmation et de protection des hôtes SQL Server.

L'exemple de code suivant implémente une application console qui se compose d'une classe avec deux méthodes publiques.

La méthode Main examine les arguments de ligne de commande et détermine si le résultat du suivi doit être dirigé vers le flux d'erreurs standard ou le flux de sortie standard. Main crée et initialise un objet ConsoleTraceListener pour le flux de sortie Console spécifié et ajoute cet objet à la collection d'écouteurs de la trace. Elle appelle ensuite la méthode WriteEnvironmentInfoToTrace qui écrit les informations relatives à l'environnement d'exécution et à la configuration de l'écouteur de la trace dans la sortie de trace.

Lorsque l'application d'exemple s'exécute, les informations d'environnement et de configuration de la trace sont écrites dans le flux de sortie de console spécifié via l'objet ConsoleTraceListener.

// 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();

    }

}

.NET Framework

.NET Framework Client Profile

Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (rôle principal du serveur non pris en charge), Windows Server 2008 R2 (rôle principal du serveur pris en charge avec SP1 ou version ultérieure ; Itanium non pris en charge)

Référence