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

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

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

void main()
{
   #if defined(TRACE)
   // 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 = 
      gcnew TextWriterTraceListener( myFile );
   Trace::Listeners->Add( myTextListener );
  
   // Write output to the file.
   Trace::Write( "Test output " );
  
   // Flush the output.
   Trace::Flush();
   Trace::Close();
   #endif
}
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 受け取るテキスト ライターを取得または設定するための プロパティを提供します。

重要

この型は IDisposable インターフェイスを実装します。 型の使用が完了したら、直接的または間接的に型を破棄する必要があります。 直接的に型を破棄するには、try/catch ブロック内で Dispose メソッドを呼び出します。 間接的に型を破棄するには、using (C# の場合) または Using (Visual Basic 言語) などの言語構成要素を使用します。 詳細については、IDisposable インターフェイスに関するトピック内の「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>  

注意

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

コンストラクター

TextWriterTraceListener()

TextWriter を出力宛先として TextWriterTraceListener クラスの新しいインスタンスを初期化します。

TextWriterTraceListener(Stream)

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

TextWriterTraceListener(Stream, String)

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

TextWriterTraceListener(String)

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

TextWriterTraceListener(String, String)

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

TextWriterTraceListener(TextWriter)

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

TextWriterTraceListener(TextWriter, String)

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

プロパティ

Attributes

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

(継承元 TraceListener)
Filter

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

(継承元 TraceListener)
IndentLevel

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

(継承元 TraceListener)
IndentSize

1 つのインデントに含まれるスペースの数を取得または設定します。

(継承元 TraceListener)
IsThreadSafe

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

(継承元 TraceListener)
Name

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

(継承元 TraceListener)
NeedIndent

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

(継承元 TraceListener)
TraceOutputOptions

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

(継承元 TraceListener)
Writer

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

メソッド

Close()

Writer を終了して、トレース出力またはデバッグ出力を受信しないようにします。

Close()

派生クラスでオーバーライドされた場合、出力ストリームを終了して、トレース出力またはデバッグ出力を受信しないようにします。

(継承元 TraceListener)
CreateObjRef(Type)

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

(継承元 MarshalByRefObject)
Dispose()

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

(継承元 TraceListener)
Dispose(Boolean)

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

Equals(Object)

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

(継承元 Object)
Fail(String)

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

(継承元 TraceListener)
Fail(String, 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)

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

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

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

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

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

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

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

(継承元 TraceListener)
Write(Object)

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

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

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

(継承元 TraceListener)
Write(String)

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

Write(String, String)

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

(継承元 TraceListener)
WriteIndent()

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

(継承元 TraceListener)
WriteLine(Object)

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

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

TraceListener クラスの実装時に作成したリスナーにカテゴリ名、オブジェクトの ToString() メソッドの値、および行終端記号を書き込みます。

(継承元 TraceListener)
WriteLine(String)

このインスタンスの Writer にメッセージを書き込み、続けて行終端記号を書き込みます。 既定の行終端記号は、キャリッジ リターンの次に改行が付いた形です (\r\n)。

WriteLine(String, String)

TraceListener クラスの実装時に作成したリスナーにカテゴリ名、メッセージ、および行終端記号を書き込みます。

(継承元 TraceListener)

適用対象

こちらもご覧ください