Elemento <add> para <sharedListeners>

Artículo
08/10/2011

Agrega un agente de escucha a la colección sharedListeners. sharedListeners es una colección de agentes de escucha a los que puede hacer referencia cualquier <source> (Elemento) o Elemento <trace>. De forma predeterminada, los agentes de escucha de la colección sharedListeners no se colocan en una colección Listeners. Deben agregarse por nombre al <source> (Elemento) o Elemento <trace>. No es posible obtener los agentes de escucha en la colección sharedListeners mediante código en tiempo de ejecución.

<add name="name" 
  type="TraceListenerClassName, Version, Culture, PublicKeyToken"
  initializeData="data"/>

Atributos y elementos

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

Atributos

Atributo	Descripción
name	Atributo necesario. Especifica el nombre del agente de escucha utilizado para agregar el agente de escucha compartido a una colección Listeners.
type	Atributo necesario. Especifica el tipo del agente de escucha. Debe utilizar una cadena que cumpla los requisitos enumerados en Especificar nombres de tipo completos.
initializeData	Atributo opcional. Cadena pasada al constructor de la clase especificada.

name

Atributo necesario.

Especifica el nombre del agente de escucha utilizado para agregar el agente de escucha compartido a una colección Listeners.

type

Atributo necesario.

Especifica el tipo del agente de escucha. Debe utilizar una cadena que cumpla los requisitos enumerados en Especificar nombres de tipo completos.

initializeData

Atributo opcional.

Cadena pasada al constructor de la clase especificada.

Elementos secundarios

Elemento	Descripción
Elemento <filter> de <add> de <sharedListeners>	Agrega un filtro a un agente de escucha contenido en la colección sharedListeners.

Elementos primarios

Elemento	Descripción
configuration	Elemento raíz de cada archivo de configuración usado por las aplicaciones de Common Language Runtime y .NET Framework.
system.diagnostics	Especifica los agentes de escucha de seguimiento que recopilan, almacenan y enrutan mensajes, y el nivel donde se establece un modificador de seguimiento.
sharedListeners	Colección de agentes de escucha a los que puede hacer referencia cualquier origen o elemento de seguimiento.

Comentarios

Las clases de agente de escucha incluidas en .NET Framework se derivan de la clase TraceListener. El valor del atributo name se utiliza para agregar el agente de escucha compartido a una colección Listeners para un seguimiento o un origen de seguimiento. El valor del atributo initializeData depende del tipo de agente de escucha que se cree. No todos los agentes de escucha de traza requieren que se especifique initializeData.

Nota
Cuando se utiliza el atributo initializeData, puede que aparezca 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 traza que tienen un constructor que toma un parámetro.

Cuando se utiliza el atributo initializeData, puede que aparezca 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 traza que tienen un constructor que toma un parámetro.

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

Clase de agente de escucha de traza	Valor del atributo initializeData
ConsoleTraceListener	El valor de useErrorStream para el constructor ConsoleTraceListener. Establezca el atributo initializeData en "true" para escribir los resultados de la traza y la depuración en el flujo estándar de error; establézcalo en "false" para escribir en el flujo estándar de salida.
DelimitedListTraceListener	Nombre del archivo en el que escribe DelimitedListTraceListener.
System.Diagnostics.EventLogTraceListener	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.
XmlWriterTraceListener	Nombre del archivo en el que escribe XmlWriterTraceListener.

Archivo de configuración

Este elemento se puede utilizar en el archivo de configuración del equipo (Machine.config) y en el archivo de configuración de la aplicación.

Ejemplo

En los ejemplos siguientes se muestra el uso de elementos <add> para agregar el textListener de TextWriterTraceListener a la colección sharedListeners. textListener se agrega por nombre a la colección Listeners para el origen de seguimiento TraceSourceApp. El agente de escucha textListener escribe el resultado del seguimiento en el archivo 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>