TextWriterTraceListener クラスとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

TextWriterTraceListener クラス

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

名前空間: System.Diagnostics
アセンブリ: System (system.dll 内)
構文

Visual Basic (宣言)

Public Class TextWriterTraceListener
    Inherits TraceListener

Visual Basic (使用法)

Dim instance As TextWriterTraceListener

public class TextWriterTraceListener : TraceListener

C++

public ref class TextWriterTraceListener :
 public TraceListener

public class TextWriterTraceListener extends
 TraceListener

JScript

public class TextWriterTraceListener extends
 TraceListener

解説

メモ
このクラスに適用される HostProtectionAttribute 属性の Resources プロパティの値は、Synchronization です。HostProtectionAttribute は、デスクトップアプリケーション (一般的には、アイコンをダブルクリック、コマンドを入力、またはブラウザに URL を入力して起動するアプリケーション) には影響しません。詳細については、HostProtectionAttribute クラスのトピックまたは「SQL Server プログラミングとホスト保護属性」を参照してください。

メモ

このクラスに適用される HostProtectionAttribute 属性の Resources プロパティの値は、Synchronization です。HostProtectionAttribute は、デスクトップアプリケーション (一般的には、アイコンをダブルクリック、コマンドを入力、またはブラウザに URL を入力して起動するアプリケーション) には影響しません。詳細については、HostProtectionAttribute クラスのトピックまたは「SQL Server プログラミングとホスト保護属性」を参照してください。

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

また、トレース出力またはデバッグ出力を受け取らないようにするために Writer を Close メソッド、Writer の出力バッファを Flush メソッド、および Writer へのメッセージを Write メッセージも、このクラスが提供します。

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

C# でデバッグを有効にするには、コードのコンパイル時に /d:DEBUG フラグをコンパイラのコマンドラインに追加するか、#define DEBUG をファイルの最上部に挿入します。Visual Basic では、コンパイラのコマンドラインに /d:DEBUG=True フラグを追加します。
C# でトレースを有効にするには、コードのコンパイル時に /d:TRACE フラグをコンパイラのコマンドラインに追加するか、#define TRACE をファイルの最上部に挿入します。Visual Basic では、コンパイラのコマンドラインに /d:TRACE=True フラグを追加します。

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

<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 が自動的に付けられます。

Topic	Location
チュートリアル : ASP.NET トレースと System.Diagnostics トレースの統合	ASP .NET Web アプリケーションの作成

使用例

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

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

Visual Basic

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

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;
 }

}

C++

int main()
{
   
   // 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();
   return 0;
}

public class Sample
{
    public static void 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.get_Listeners().Add(myTextListener);

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

        // Flush the output.
        Trace.Flush();
        return;
    } //main
} //Sample

継承階層

System.Object
   System.MarshalByRefObject
     System.Diagnostics.TraceListener
      System.Diagnostics.TextWriterTraceListener
         System.Diagnostics.ConsoleTraceListener
         System.Diagnostics.DelimitedListTraceListener
         System.Diagnostics.XmlWriterTraceListener

スレッドセーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッドセーフです。インスタンスメンバの場合は、スレッドセーフであるとは限りません。