<add>, élément de <listeners> pour <source>

Article
08/21/2008

Mise à jour : novembre 2007

Ajoute un écouteur à la collection Listeners pour une source de trace.

<configuration>, élément
  <system.diagnostics>, élément
    <sources>, élément
      <source>, élément
        <listeners>, élément de <trace>
          <add>, élément de <listeners> pour <source>

<add name="name" 
  type="TraceListenerClassName, 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 devez utiliser une chaîne qui répond aux conditions énoncées dans Spécification des noms de types qualifiés complets.
initializeData	Attribut facultatif. Chaîne passée au constructeur pour la classe spécifiée. Une exception ConfigurationException est levée si la classe ne possède pas de constructeur qui prend une chaîne.
name	Attribut facultatif. Spécifie le nom de l'écouteur.
traceOutputOptions	Attribut facultatif. Spécifie la valeur de la propriété TraceOutputOptions pour l'écouteur de la trace.
[attributs personnalisés]	Attributs facultatifs. Spécifie la valeur des attributs spécifiques à l'écouteur identifiés par la méthode GetSupportedAttributes pour cet écouteur. Delimiter est un exemple d'attribut supplémentaire, unique à la classe DelimitedListTraceListener.

Éléments enfants

Élément	Description
<filter>, élément de <add> pour <listeners> pour <source>	Ajoute un filtre à un écouteur dans la collection Listeners pour une source de 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.
system.diagnostics	Spécifie les écouteurs de traçage qui collectent, stockent et routent des messages, ainsi que le niveau auquel un commutateur de traçage est défini.
sources	Contient des sources de trace qui initient des messages de traçage.
source	Spécifie une source de trace qui initie le traçage des messages.
listeners	Spécifie des écouteurs qui collectent, stockent et routent des messages.

Notes

Les classes d'écouteur livrées avec le .NET Framework dérivent de la classe TraceListener.

Si vous ne spécifiez pas l'attribut name de l'écouteur de la trace, la propriété Name de l'écouteur de la trace prend comme valeur par défaut une chaîne vide (""). Si votre application n'a qu'un seul écouteur, vous pouvez l'ajouter sans spécifier de nom et le supprimer en spécifiant une chaîne vide en tant que nom. Toutefois, si votre application possède plusieurs écouteurs, vous devez spécifier un nom unique pour chaque écouteur de la trace, ce qui permet d'identifier et de gérer des écouteurs de trace individuels dans la collection TraceSource.Listeners.

Remarque :
Si vous ajoutez plusieurs écouteurs de la trace possédant le même type et le même nom, un seul écouteur de la trace de ce type et de ce nom est ajouté à la collection Listeners. Toutefois, vous pouvez ajouter par programme plusieurs écouteurs identiques à la collection Listeners.

La valeur de l'attribut initializeData dépend du type d'écouteur que vous créez. Il n'est pas nécessaire de spécifier initializeData pour tous les écouteurs de la trace.

Remarque :
Lorsque vous utilisez l'attribut initializeData, le message d'avertissement du compilateur suivant peut s'afficher : « L'attribut 'initializeData' n'est pas déclaré. ». Cet avertissement s'affiche, 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 général, vous pouvez ignorer cet avertissement pour les implémentations de l'écouteur de la trace disposant d'un constructeur qui accepte un paramètre.

Lorsque vous utilisez l'attribut initializeData, le message d'avertissement du compilateur suivant peut s'afficher : « L'attribut 'initializeData' n'est pas déclaré. ». Cet avertissement s'affiche, 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 général, vous pouvez ignorer cet avertissement pour les implémentations de l'écouteur de la trace disposant d'un constructeur qui accepte un paramètre.

Le tableau suivant présente les écouteurs de la trace inclus avec le .NET Framework et décrit la valeur de leur attribut initializeData.

Classe d'écouteur de traces	initializeData, valeur d'attribut
System.Diagnostics.ConsoleTraceListener	Valeur useErrorStream pour le constructeur ConsoleTraceListener. Affectez la valeur true à l'attribut initializeData pour écrire la sortie de la trace et du débogage dans le flux d'erreurs standard ; affectez-lui la valeur false pour l'écrire dans le flux de sortie standard.
System.Diagnostics.DelimitedListTraceListener	Nom du fichier vers lequel DelimitedListTraceListener écrit.
System.Diagnostics.EventLogTraceListener	Nom d'une source existante de journal des événements.
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.

Fichier de configuration

Cet élément peut être utilisé dans le fichier de configuration machine (Machine.config) et dans le fichier de configuration de l'application.

Exemple

L'exemple suivant montre comment utiliser des éléments <add> pour ajouter les écouteurs console et textListener à la collection Listeners pour la source de trace TraceSourceApp. L'écouteur textListener écrit la sortie de la trace dans le fichier myListener.log.

<configuration>
  <system.diagnostics>
    <sources>
      <source name="TraceSourceApp" switchName="sourceSwitch" 
        switchType="System.Diagnostics.SourceSwitch">
        <listeners>
          <add name="console" 
            type="System.Diagnostics.ConsoleTraceListener"/>
          <add name="textListener"/>
          <remove name="Default"/>
        </listeners>
      </source>
    </sources>
    <sharedListeners>
      <add name="textListener" 
        type="System.Diagnostics.TextWriterTraceListener" 
        initializeData="myListener.log"/>
    </sharedListeners>
    <switches>
      <add name="sourceSwitch" value="Warning"/>
    </switches>
  </system.diagnostics>
</configuration>