Share via

<sharedListeners> の <add> 要素

  • [アーティクル]

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

<configuration>
  <system.diagnostics>
    <sharedListeners>
      <add>

構文

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

属性および要素

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

属性

属性 説明
name 必須の属性です。

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

リスナーの種類を指定します。 「完全修飾型名の指定」で指定された要件を満たす文字列を使用する必要があります。
initializeData 省略可能な属性です。

指定されたクラスのコンストラクターに渡される文字列。
traceOutputOptions 省略可能な属性です。

トレース出力に書き込まれるデータを示す 1 つまたは複数の TraceOptions 列挙メンバーの文字列表記。 複数の変数はコンマで区切られます。 既定値は "None" です。

子要素

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

親要素

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

解説

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

Note

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>

関連項目