Élément <add> pour <listeners> pour <trace>

  • Article

Ajoute un écouteur à la collection Listeners.

<configuration>
  <system.diagnostics>
    <trace>
      <listeners>
        <add>

Syntaxe

<add name="name"
     type="trace listener class name, Version, Culture, PublicKeyToken"  
     initializeData="data"/>

Attributs et éléments

Les sections suivantes décrivent des attributs, des éléments enfants et des éléments parents.

Attributs

Attribut Description
type Attribut requis.

Spécifie le type de l’écouteur. Vous pouvez utiliser une chaîne qui répond aux exigences spécifiées dans Spécification des noms de types complets.
initializeData Attribut facultatif.

Chaîne transmise au constructeur pour la classe spécifiée.
name Attribut facultatif.

Spécifie le nom de l’écouteur.

Éléments enfants

Élément Description
<filter> Ajoute un filtre à un écouteur de la collection Listeners pour une trace.

Éléments parents

Élément Description
configuration Élément racine de chaque fichier de configuration utilisé par le Common Language Runtime et les applications .NET Framework.
listeners Spécifie un écouteur qui collecte, stocke et route les messages. Les écouteurs dirigent la sortie de traçage vers une cible appropriée.
system.diagnostics Spécifie l'élément racine de la section de configuration ASP.NET.
trace Contient les écouteurs qui collectent, stockent et acheminent les messages de traçage.

Notes

Les classes Debug et Trace partagent la même collection Listeners. Si vous ajoutez un objet écouteur à la collection dans l’une de ces classes, l’autre classe utilise le même écouteur. Les classes d’écouteur dérivent de TraceListener.

Si vous ne spécifiez pas l’attribut name de l’écouteur de trace, la propriété Name de l’écouteur de trace est définie par défaut sur une chaîne vide (""). Si votre application ne dispose que d’un seul écouteur, vous pouvez l’ajouter sans spécifier de nom et le supprimer en spécifiant une chaîne vide pour le nom. Cependant, si votre application possède plusieurs écouteurs, vous devez spécifier un nom unique pour chaque écouteur de trace, ce qui vous permet d’identifier et de gérer individuellement chaque écouteur de trace au sein des collections Listeners et Listeners.

Notes

L’ajout de plusieurs écouteurs de trace de même type et de même nom entraîne l’ajout d’un seul écouteur de trace de ce type et de ce nom à la collection Listeners. Cependant, vous pouvez ajouter par programmation plusieurs écouteurs identiques à la collection Listeners.

La valeur de l’attribut initializeData dépend du type d’écouteur que vous créez. Pour certains écouteurs de trace, il n’est pas nécessaire de spécifier initializeData.

Notes

Quand vous utilisez l’attribut initializeData, il se peut que obteniez un avertissement du compilateur indiquant que l’attribut « InitializeData » n’est pas déclaré. Cet avertissement apparaît, car les paramètres de configuration sont validés par rapport à la classe de base abstraite TraceListener, qui ne reconnaît pas l’attribut initializeData. En règle générale, vous pouvez ignorer cet avertissement pour les implémentations d’écouteur de trace doté d’un constructeur qui accepte un paramètre.

Le tableau suivant présente les écouteurs de trace qui accompagnent .NET Framework et décrit la valeur de leurs attributs initializeData.

Classe d’écouteur de trace Valeur d’attribut initializeData
System.Diagnostics.ConsoleTraceListener Valeur useErrorStream du constructeur ConsoleTraceListener. Définissez l’attribut initializeData sur « true » pour écrire la sortie de trace et de débogage dans Console.Error et sur « false » pour écrire dans Console.Out.
System.Diagnostics.DelimitedListTraceListener Nom du fichier vers lequel DelimitedListTraceListener écrit.
System.Diagnostics.EventLogTraceListener Nom d’une source de journal d’événements existante.
System.Diagnostics.EventSchemaTraceListener Nom du fichier dans lequel EventSchemaTraceListener écrit.
System.Diagnostics.TextWriterTraceListener Nom du fichier dans lequel TextWriterTraceListener écrit.
System.Diagnostics.XmlWriterTraceListener Nom du fichier dans lequel XmlWriterTraceListener écrit.

Exemple

L’exemple suivant montre comment utiliser des éléments <add> pour ajouter les écouteurs MyListener et MyEventListener à la collection Listeners. MyListener crée un fichier appelé MyListener.log et écrit la sortie dans le fichier. MyEventListener crée une entrée dans le journal des événements.

<configuration>  
   <system.diagnostics>  
      <trace autoflush="true" indentsize="0">  
         <listeners>  
            <add name="myListener" type="System.Diagnostics.TextWriterTraceListener, system, version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" initializeData="c:\myListener.log" />  
            <add name="MyEventListener"  
                 type="System.Diagnostics.EventLogTraceListener, system, version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089"                 initializeData="MyConfigEventLog"/>  
            <add name="configConsoleListener"  
                 type="System.Diagnostics.ConsoleTraceListener, system, version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089"/>  
         </listeners>  
      </trace>  
   </system.diagnostics>  
</configuration>

Voir aussi