<sharedListeners> の <add> 要素

[アーティクル]
08/16/2008

更新 : 2007 年 11 月

sharedListeners コレクションにリスナを追加します。sharedListeners は、任意の <source> 要素または <trace> 要素が参照できるリスナのコレクションです。既定では、sharedListeners コレクションのリスナは Listeners コレクションに配置されません。これらは、<source> 要素または <trace> 要素に名前で追加する必要があります。実行時に、sharedListeners コレクションのリスナをコードで取得することはできません。

<configuration> 要素
   <system.diagnostics> 要素
     <sharedListeners> 要素
       <source> の <listeners> の <add> 要素

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

属性と要素

以降のセクションでは、属性、子要素、および親要素について説明します。

属性

属性	説明
name	必須属性共有リスナを Listeners コレクションに追加するために使用されるリスナの名前を指定します。
type	必須属性リスナの型を指定します。「完全修飾型名の指定」で指定されている要件を満たす文字列を使用する必要があります。
initializeData	省略可能属性指定したクラスのコンストラクタに渡す文字列。

name

必須属性

共有リスナを Listeners コレクションに追加するために使用されるリスナの名前を指定します。

type

必須属性

リスナの型を指定します。「完全修飾型名の指定」で指定されている要件を満たす文字列を使用する必要があります。

initializeData

省略可能属性

指定したクラスのコンストラクタに渡す文字列。

子要素

要素	説明
<sharedListeners> の <add> の <filter> 要素	フィルタを sharedListeners コレクションのリスナに追加します。

親要素

要素	説明
configuration	共通言語ランタイムおよび .NET Framework アプリケーションで使用されるすべての構成ファイルのルート要素です。
system.diagnostics	メッセージを収集、格納、およびルーティングするトレースリスナとトレーススイッチを設定するレベルを指定します。
sharedListeners	任意の source 要素または trace 要素が参照できるリスナのコレクション。

解説

.NET Framework に付属のリスナクラスは、TraceListener クラスの派生クラスです。name 属性の値は、トレースまたはトレースソースの Listeners コレクションに共有リスナを追加するために使用されます。initializeData 属性の値は、作成するリスナの型によって異なります。initializeData を指定する必要のないトレースリスナもあります。

メモ :
initializeData 属性を使用すると、"initializeData 属性は宣言されていません" というコンパイラの警告が表示される場合があります。この警告は、initializeData 属性を認識しない TraceListener 抽象基本クラスに対して構成設定が検証されたために発生します。通常、パラメータを受け取るコンストラクタのあるトレースリスナの実装では、この警告を無視してもかまいません。

initializeData 属性を使用すると、"initializeData 属性は宣言されていません" というコンパイラの警告が表示される場合があります。この警告は、initializeData 属性を認識しない TraceListener 抽象基本クラスに対して構成設定が検証されたために発生します。通常、パラメータを受け取るコンストラクタのあるトレースリスナの実装では、この警告を無視してもかまいません。

.NET Framework に付属するトレースリスナを次の表に示し、各リスナの initializeData 属性の値を説明します。

トレースリスナクラス	initializeData 属性の値
ConsoleTraceListener	ConsoleTraceListener コンストラクタの useErrorStream 値。initializeData 属性を "true" に設定すると、トレース出力とデバッグ出力を標準エラー出力ストリームに書き込みます。"false" に設定すると、標準出力ストリームに書き込みます。
DelimitedListTraceListener	DelimitedListTraceListener が出力を書き込むファイルの名前。
System.Diagnostics.EventLogTraceListener	既存のイベントログソースの名前。
System.Diagnostics.EventSchemaTraceListener	EventSchemaTraceListener が出力を書き込むファイルの名前。
System.Diagnostics.TextWriterTraceListener	TextWriterTraceListener が出力を書き込むファイルの名前。
XmlWriterTraceListener	XmlWriterTraceListener が出力を書き込むファイルの名前。

構成ファイル

この要素は、マシン構成ファイル (Machine.config) およびアプリケーション構成ファイルで使用できます。

使用例

<add> 要素を使用して TextWriterTraceListenertextListener を sharedListeners コレクションに書き込む方法を次の例に示します。textListener は、トレースソース TraceSourceApp の Listeners コレクションに名前で追加されます。textListener リスナは、トレース出力を 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>