TextWriterTraceListener クラス

定義

トレースまたはデバッグ出力を TextWriter または Stream(FileStreamなど) に転送します。

public ref class TextWriterTraceListener : System::Diagnostics::TraceListener
public class TextWriterTraceListener : System.Diagnostics.TraceListener
type TextWriterTraceListener = class
    inherit TraceListener
Public Class TextWriterTraceListener
Inherits TraceListener
継承
TextWriterTraceListener
継承
TextWriterTraceListener
派生

次の例では、TextWriterTraceListener というStreamWriterを使用して myOutputWriter という名前のファイルに書き込むTestFile.txt クラスのインスタンスを実装します。 最初に、出力用のファイルを作成します。 次に、最初のテキスト ライターの StreamWriter を作成し、出力ファイルを割り当てて、 Listenersに追加します。 次に、コードは 1 行のテキストをファイルに出力します。 最後に、出力バッファーをフラッシュします。

このサンプルを実行した後、 TestFile.txt ファイルを開いて出力を確認できます。

public class Sample
{

public static int Main(string[] args) {
    // Create a file for output named TestFile.txt.
    Stream myFile = File.Create("TestFile.txt");

    /* Create a new text writer using the output stream, and add it to
     * the trace listeners. */
    TextWriterTraceListener myTextListener = new
       TextWriterTraceListener(myFile);
    Trace.Listeners.Add(myTextListener);

    // Write output to the file.
    Trace.Write("Test output ");

    // Flush the output.
    Trace.Flush();

    return 0;
 }
}
Public Class Sample
    
    Public Shared Sub Main()
        ' Create a file for output named TestFile.txt.
        Dim myFile As Stream = File.Create("TestFile.txt")
        
        ' Create a new text writer using the output stream, and add it to
        ' the trace listeners. 
        Dim myTextListener As New TextWriterTraceListener(myFile)
        Trace.Listeners.Add(myTextListener)

        
        ' Write output to the file.
        Trace.Write("Test output ")
        
        ' Flush the output.
        Trace.Flush() 

        System.Environment.ExitCode = 0
    End Sub

End Class

注釈

TextWriterTraceListener クラスは、トレース出力またはデバッグ出力を受け取るテキスト ライターを取得または設定するWriter プロパティを提供します。

Important

この型は、IDisposable インターフェイスを実装します。 型の使用が完了したら、( Dispose メソッドを呼び出して) 直接破棄するか、間接的に (C# で using などの言語コンストラクトを使用して) 破棄する必要があります。 詳細については、「 IDisposable を実装するオブジェクトを使用する」を参照してください。

このクラスには、トレースまたはデバッグ出力を受信しなくなったCloseWriterしたり、Flushの出力バッファーをWriterしたり、メッセージをWriteWriterしたりするメソッドも用意されています。

トレース リスナーを使用するには、トレースまたはデバッグを有効にする必要があります。 次の構文はコンパイラ固有です。 C# または Visual Basic 以外のコンパイラを使用する場合は、コンパイラのドキュメントを参照してください。

  • C# でデバッグを有効にするには、コードをコンパイルするときに /d:DEBUG フラグをコンパイラ のコマンド ラインに追加するか、ファイルの先頭に #define DEBUG を追加します。 Visual Basic で、 /d:DEBUG=True フラグをコンパイラ のコマンド ラインに追加します。

  • C# でトレースを有効にするには、コードのコンパイル時に /d:TRACE フラグをコンパイラ コマンド ラインに追加するか、ファイルの先頭に #define TRACE を追加します。 Visual Basic で、 /d:TRACE=True フラグをコンパイラ のコマンド ラインに追加します。

.NET Framework アプリにトレース リスナーを追加するには、アプリケーションの名前に対応する構成ファイルを編集します。 このファイル内では、リスナーの追加、その型の設定、パラメーターの設定、リスナーの削除、またはアプリケーションによって以前に設定されたすべてのリスナーのクリアを行うことができます。 構成ファイルは、次の例のように書式設定する必要があります。

<configuration>
  <system.diagnostics>
    <trace autoflush="false" indentsize="4">
      <listeners>
        <add name="myListener"
          type="System.Diagnostics.TextWriterTraceListener"
          initializeData="TextWriterOutput.log" />
        <remove name="Default" />
      </listeners>
    </trace>
  </system.diagnostics>
</configuration>

Note

使用中または使用できないファイルに書き込もうとすると、ファイル名の先頭に GUID が自動的に付けられます。

コンストラクター

名前 説明
TextWriterTraceListener()

TextWriterTraceListenerを出力受信者として使用して、TextWriter クラスの新しいインスタンスを初期化します。

TextWriterTraceListener(Stream, String)

デバッグ出力とトレース出力の受信者としてストリームを使用して、指定した名前で TextWriterTraceListener クラスの新しいインスタンスを初期化します。

TextWriterTraceListener(Stream)

デバッグ出力とトレース出力の受信者としてストリームを使用して、 TextWriterTraceListener クラスの新しいインスタンスを初期化します。

TextWriterTraceListener(String, String)

デバッグ出力とトレース出力の受信者としてファイルを使用して、指定した名前で TextWriterTraceListener クラスの新しいインスタンスを初期化します。

TextWriterTraceListener(String)

デバッグ出力とトレース出力の受信者としてファイルを使用して、 TextWriterTraceListener クラスの新しいインスタンスを初期化します。

TextWriterTraceListener(TextWriter, String)

指定したライターをトレース出力またはデバッグ出力の受信者として使用して、指定した名前で TextWriterTraceListener クラスの新しいインスタンスを初期化します。

TextWriterTraceListener(TextWriter)

指定したライターをトレース出力またはデバッグ出力の受信者として使用して、 TextWriterTraceListener クラスの新しいインスタンスを初期化します。

プロパティ

名前 説明
Attributes

アプリケーション構成ファイルで定義されているカスタム トレース リスナー属性を取得します。

(継承元 TraceListener)
Filter

トレース リスナーのトレース フィルターを取得または設定します。

(継承元 TraceListener)
IndentLevel

インデント レベルを取得または設定します。

(継承元 TraceListener)
IndentSize

インデント内のスペースの数を取得または設定します。

(継承元 TraceListener)
IsThreadSafe

トレース リスナーがスレッド セーフかどうかを示す値を取得します。

(継承元 TraceListener)
Name

この TraceListenerの名前を取得または設定します。

(継承元 TraceListener)
NeedIndent

出力をインデントするかどうかを示す値を取得または設定します。

(継承元 TraceListener)
TraceOutputOptions

トレース出力オプションを取得または設定します。

(継承元 TraceListener)
Writer

トレース出力またはデバッグ出力を受け取るテキスト ライターを取得または設定します。

メソッド

名前 説明
Close()

トレースまたはデバッグ出力を受信しなくなったように、 Writer を閉じます。

CreateObjRef(Type)

リモート オブジェクトとの通信に使用されるプロキシの生成に必要なすべての関連情報を含むオブジェクトを作成します。

(継承元 MarshalByRefObject)
Dispose()

TraceListenerで使用されているすべてのリソースを解放します。

(継承元 TraceListener)
Dispose(Boolean)

この TextWriterTraceListener オブジェクトを破棄します。

Equals(Object)

指定したオブジェクトが現在のオブジェクトと等しいかどうかを判断します。

(継承元 Object)
Fail(String, String)

TraceListener クラスを実装するときに作成するリスナーにエラー メッセージと詳細なエラー メッセージを出力します。

(継承元 TraceListener)
Fail(String)

TraceListener クラスを実装するときに作成したリスナーにエラー メッセージを出力します。

(継承元 TraceListener)
Flush()

Writerの出力バッファーをフラッシュします。

GetHashCode()

既定のハッシュ関数として機能します。

(継承元 Object)
GetLifetimeService()
古い.

このインスタンスの有効期間ポリシーを制御する現在の有効期間サービス オブジェクトを取得します。

(継承元 MarshalByRefObject)
GetSupportedAttributes()

トレース リスナーでサポートされているカスタム属性を取得します。

(継承元 TraceListener)
GetType()

現在のインスタンスの Type を取得します。

(継承元 Object)
InitializeLifetimeService()
古い.

このインスタンスの有効期間ポリシーを制御する有効期間サービス オブジェクトを取得します。

(継承元 MarshalByRefObject)
MemberwiseClone()

現在の Objectの簡易コピーを作成します。

(継承元 Object)
MemberwiseClone(Boolean)

現在の MarshalByRefObject オブジェクトの簡易コピーを作成します。

(継承元 MarshalByRefObject)
ToString()

現在のオブジェクトを表す文字列を返します。

(継承元 Object)
TraceData(TraceEventCache, String, TraceEventType, Int32, Object)

トレース情報、データ オブジェクト、およびイベント情報をリスナー固有の出力に書き込みます。

(継承元 TraceListener)
TraceData(TraceEventCache, String, TraceEventType, Int32, Object[])

トレース情報、データ オブジェクトの配列、およびイベント情報をリスナー固有の出力に書き込みます。

(継承元 TraceListener)
TraceEvent(TraceEventCache, String, TraceEventType, Int32, String, Object[])

トレース情報、オブジェクトの書式設定された配列、およびイベント情報をリスナー固有の出力に書き込みます。

(継承元 TraceListener)
TraceEvent(TraceEventCache, String, TraceEventType, Int32, String)

トレース情報、メッセージ、およびイベント情報をリスナー固有の出力に書き込みます。

(継承元 TraceListener)
TraceEvent(TraceEventCache, String, TraceEventType, Int32)

トレースとイベントの情報をリスナー固有の出力に書き込みます。

(継承元 TraceListener)
TraceTransfer(TraceEventCache, String, Int32, String, Guid)

トレース情報、メッセージ、関連するアクティビティ ID、イベント情報をリスナー固有の出力に書き込みます。

(継承元 TraceListener)
Write(Object, String)

ToString() クラスを実装するときに作成するリスナーに、カテゴリ名とオブジェクトの TraceListener メソッドの値を書き込みます。

(継承元 TraceListener)
Write(Object)

ToString() クラスを実装するときに作成するリスナーに、オブジェクトの TraceListener メソッドの値を書き込みます。

(継承元 TraceListener)
Write(String, String)

TraceListener クラスを実装するときに作成するリスナーに、カテゴリ名とメッセージを書き込みます。

(継承元 TraceListener)
Write(String)

このインスタンスの Writerにメッセージを書き込みます。

WriteIndent()

このクラスを実装するときに作成するリスナーにインデントを書き込み、NeedIndent プロパティを falseにリセットします。

(継承元 TraceListener)
WriteLine(Object, String)

ToString() クラスを実装するときに作成するリスナーに、カテゴリ名とオブジェクトの TraceListener メソッドの値を書き込み、続けて行ターミネータを書き込みます。

(継承元 TraceListener)
WriteLine(Object)

ToString() クラスを実装するときに作成するリスナーに、オブジェクトの TraceListener メソッドの値を書き込み、続けて行終端記号を書き込みます。

(継承元 TraceListener)
WriteLine(String, String)

TraceListener クラスを実装するときに作成するリスナーに、カテゴリ名とメッセージを書き込み、続けて行終端記号を書き込みます。

(継承元 TraceListener)
WriteLine(String)

このインスタンスの Writer にメッセージを書き込み、続けて行終端記号を書き込みます。 既定のライン ターミネータは、復帰の後に改行 (\r\n) が続きます。

適用対象

こちらもご覧ください