Elemento <add> de <listeners> de <trace>

Artículo
12/12/2008

Actualización: noviembre 2007

Agrega un agente de escucha a la colección Listeners.

<configuration> (Elemento)
  Elemento <system.diagnostics>
    Elemento <trace>
      Elemento <listeners> para <trace>
        Elemento <add> de <listeners> de <trace>

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

Atributos y elementos

En las siguientes secciones se describen los atributos, elementos secundarios y elementos primarios.

Atributos

Atributo	Descripción
tipo	Atributo requerido. Especifica el tipo del agente de escucha. Se debe utilizar una cadena que cumpla los requisitos especificados en Especificar nombres de tipo completos.
initializeData	Atributo opcional. Cadena pasada al constructor de la clase especificada.
nombre	Atributo opcional. Especifica el nombre del agente de escucha.

tipo

Atributo requerido.

Especifica el tipo del agente de escucha. Se debe utilizar una cadena que cumpla los requisitos especificados en Especificar nombres de tipo completos.

initializeData

Atributo opcional.

Cadena pasada al constructor de la clase especificada.

nombre

Atributo opcional.

Especifica el nombre del agente de escucha.

Elementos secundarios

Ninguna.

Elementos primarios

Elemento	Descripción
configuration	Elemento raíz de cada archivo de configuración que utilizan las aplicaciones Common Language Runtime y .NET Framework.
listeners	Especifica un agente de escucha que recopila, almacena y enruta mensajes. Los agentes de escucha dirigen el resultado del seguimiento a un destino apropiado.
system.diagnostics	Especifica el elemento raíz de la sección de configuración de ASP.NET.
trace	Contiene agentes de escucha que recopilan, almacenan y enrutan mensajes de seguimiento.

Comentarios

Las clases Debug y Trace comparten la misma colección Listeners. Si se agrega un objeto de agente de escucha a la colección en una de estas clases, la otra clase utilizará el mismo agente de escucha. Las clases de agente de escucha derivan de la clase TraceListener.

Si no especifica el atributo name del agente de escucha de seguimiento, el atributo Name del agente de escucha de seguimiento tiene como valor predefinido una cadena vacía (""). Si su aplicación tiene sólo un agente de escucha, puede agregarlo sin especificar un nombre y quitarlo especificando una cadena vacía para el nombre. Sin embargo, si su aplicación tiene más de un agente de escucha, debe especificar nombres únicos para cada agente de escucha de seguimiento, de forma que pueda identificar y administrar los agentes de escucha de seguimiento individualmente dentro de las colecciones Listeners y Listeners.

Nota

Agregar más de un agente de escucha de seguimiento del mismo tipo y con el mismo nombre tiene como resultado que sólo se agregue a la colección Listeners un agente de escucha de seguimiento con ese tipo y nombre. Sin embargo, puede agregar mediante programación varios agentes de escucha idénticos a la colección Listeners.

El valor del atributo initializeData depende del tipo de agente de escucha que se cree. No todos los agentes de escucha de seguimiento requieren que se especifique initializeData.

Nota

Cuando se utiliza el atributo initializeData, puede aparecer la advertencia del compilador "No se ha declarado el atributo 'initializeData'". Esta advertencia se produce porque la configuración se valida con arreglo a la clase base abstracta TraceListener, que no reconoce el atributo initializeData. Por lo general, puede hacer caso omiso de esta advertencia en las implementaciones de agentes de escucha de seguimiento que tienen un constructor que toma un parámetro.

En la tabla siguiente se muestran los agentes de escucha de seguimiento incluidos en .NET Framework y se describe el valor de sus atributos initializeData.

Clase de agente de escucha de seguimiento	Valor del atributo initializeData
System.Diagnostics.ConsoleTraceListener	El valor de useErrorStream para el constructor ConsoleTraceListener. Establezca el atributo initializeData en "true" para escribir los resultados de seguimiento y depuración en Console.Error; establézcalo en "false" para escribir en Console.Out.
System.Diagnostics.DelimitedListTraceListener	Nombre del archivo en el que escribe DelimitedListTraceListener.
System.Diagnostics.EventLogTraceListener	El nombre del nombre de un origen de registro de eventos existente.
System.Diagnostics.EventSchemaTraceListener	Nombre del archivo en el que escribe EventSchemaTraceListener.
System.Diagnostics.TextWriterTraceListener	Nombre del archivo en el que escribe TextWriterTraceListener.
System.Diagnostics.XmlWriterTraceListener	Nombre del archivo en el que escribe XmlWriterTraceListener.

Ejemplo

En el siguiente ejemplo se muestra cómo utilizar los elementos <add> para agregar los agentes de escucha MyListener y MyEventListener a la colección Listeners. MyListener crea un archivo denominado MyListener.log y escribe el resultado en el archivo. MyEventListener crea una entrada en el registro de eventos.

<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>