ConsoleTraceListener クラス

定義

public ref class ConsoleTraceListener : System::Diagnostics::TextWriterTraceListener

public class ConsoleTraceListener : System.Diagnostics.TextWriterTraceListener

type ConsoleTraceListener = class
    inherit TextWriterTraceListener

Public Class ConsoleTraceListener
Inherits TextWriterTraceListener

継承

Object

MarshalByRefObject

TraceListener

TextWriterTraceListener

ConsoleTraceListener

例

次のコード例では、2 つのパブリック メソッドを持つ クラスで構成されるコンソール アプリケーションを実装します。

メソッドは Main 、コマンド ライン引数を調べて、トレース出力を標準エラー ストリームまたは標準出力ストリームに転送するかどうかを決定します。 Mainは、指定したConsole出力ストリームの オブジェクトを作成して初期化ConsoleTraceListenerし、このオブジェクトをトレース リスナー コレクションに追加します。 次に、 メソッドを WriteEnvironmentInfoToTrace 呼び出します。これにより、実行中の環境とトレース リスナーの構成に関する詳細がトレース出力に書き込まれます。

サンプル アプリケーションを実行すると、環境とトレース構成の詳細が、 オブジェクトを介して指定されたコンソール出力ストリームに ConsoleTraceListener 書き込まれます。

// Define the TRACE directive, which enables trace output to the
// Trace.Listeners collection. Typically, this directive is defined
// as a compilation argument.
#define TRACE
using System;
using System.Diagnostics;

public class ConsoleTraceSample
{

    // Define a simple method to write details about the current executing
    // environment to the trace listener collection.
    public static void WriteEnvironmentInfoToTrace()
    {

        string methodName = "WriteEnvironmentInfoToTrace";

        Trace.Indent();
        Trace.WriteLine(DateTime.Now.ToString() + " - Start of " + methodName);
        Trace.Indent();

        // Write details on the executing environment to the trace output.
        Trace.WriteLine("Operating system: " + System.Environment.OSVersion.ToString());
        Trace.WriteLine("Computer name: " + System.Environment.MachineName);
        Trace.WriteLine("User name: " + System.Environment.UserName);
        Trace.WriteLine("CLR runtime version: " + System.Environment.Version.ToString());
        Trace.WriteLine("Command line: " + System.Environment.CommandLine);

        // Enumerate the trace listener collection and
        // display details about each configured trace listener.
        Trace.WriteLine("Number of configured trace listeners = " + Trace.Listeners.Count.ToString());

        foreach (TraceListener tl in Trace.Listeners)
        {
            Trace.WriteLine("Trace listener name = " + tl.Name);
            Trace.WriteLine("               type = " + tl.GetType().ToString());
        }

        Trace.Unindent();
        Trace.WriteLine(DateTime.Now.ToString() + " - End of " + methodName);
        Trace.Unindent();
    }

    // Define the main entry point of this class.
    // The main method adds a console trace listener to the collection
    // of configured trace listeners, then writes details on the current
    // executing environment.
    public static void Main(string[] CmdArgs)
    {

        // Write a trace message to all configured trace listeners.
        Trace.WriteLine(DateTime.Now.ToString()+" - Start of Main");

        // Define a trace listener to direct trace output from this method
        // to the console.
        ConsoleTraceListener consoleTracer;

        // Check the command line arguments to determine which
        // console stream should be used for trace output.
        if ((CmdArgs.Length>0)&&(CmdArgs[0].ToString().ToLower().Equals("/stderr")))
            // Initialize the console trace listener to write
            // trace output to the standard error stream.
        {
            consoleTracer = new ConsoleTraceListener(true);
        }
        else
        {
            // Initialize the console trace listener to write
            // trace output to the standard output stream.
            consoleTracer = new ConsoleTraceListener();
        }
        // Set the name of the trace listener, which helps identify this
        // particular instance within the trace listener collection.
        consoleTracer.Name = "mainConsoleTracer";

        // Write the initial trace message to the console trace listener.
        consoleTracer.WriteLine(DateTime.Now.ToString()+" ["+consoleTracer.Name+"] - Starting output to trace listener.");

        // Add the new console trace listener to
        // the collection of trace listeners.
        Trace.Listeners.Add(consoleTracer);

        // Call a local method, which writes information about the current
        // execution environment to the configured trace listeners.
        WriteEnvironmentInfoToTrace();

        // Write the final trace message to the console trace listener.
        consoleTracer.WriteLine(DateTime.Now.ToString()+" ["+consoleTracer.Name+"] - Ending output to trace listener.");

        // Flush any pending trace messages, remove the
        // console trace listener from the collection,
        // and close the console trace listener.
        Trace.Flush();
        Trace.Listeners.Remove(consoleTracer);
        consoleTracer.Close();

        // Write a final trace message to all trace listeners.
        Trace.WriteLine(DateTime.Now.ToString()+" - End of Main");

        // Close all other configured trace listeners.
        Trace.Close();
    }
}

' Define the TRACE constant, which enables trace output to the 
' Trace.Listeners collection. Typically, this constant is defined
' as a compilation argument.
#Const TRACE = True

Imports System.Diagnostics

Public Class ConsoleTraceSample

    ' Define a simple method to write details about the current executing 
    ' environment to the trace listener collection.
    Public Shared Sub WriteEnvironmentInfoToTrace()

        Dim methodName As String = "WriteEnvironmentInfoToTrace"

        Trace.Indent()
        Trace.WriteLine(DateTime.Now.ToString() & " - Start of " & methodName)
        Trace.Indent()

        ' Write details on the executing environment to the trace output.
        Trace.WriteLine("Operating system: " & _
            System.Environment.OSVersion.ToString())
        Trace.WriteLine("Computer name: " & System.Environment.MachineName)
        Trace.WriteLine("User name: " & System.Environment.UserName)
        Trace.WriteLine("CLR version: " & System.Environment.Version.ToString)
        Trace.WriteLine("Command line: " & System.Environment.CommandLine)

        ' Enumerate the trace listener collection and 
        ' display details about each configured trace listener.
        Trace.WriteLine("Number of configured trace listeners = " & _
            Trace.Listeners.Count.ToString())

        Dim tl As TraceListener
        For Each tl In Trace.Listeners
            Trace.WriteLine("Trace listener name = " & tl.Name)
            Trace.WriteLine("               type = " & tl.GetType().ToString())
        Next tl

        Trace.Unindent()
        Trace.WriteLine(DateTime.Now.ToString() & " - End of " & methodName)
        Trace.Unindent()

    End Sub

    ' Define the main entry point of this class.
    ' The main method adds a console trace listener to the collection
    ' of configured trace listeners, then writes details on the current
    ' executing environment.
    Public Shared Sub Main(ByVal CmdArgs() As String)

        ' Write a trace message to all configured trace listeners.
        Trace.WriteLine(DateTime.Now.ToString() & " - Start of Main")

        ' Define a trace listener to direct trace output from this method
        ' to the console.
        Dim consoleTracer As ConsoleTraceListener

        ' Check the command line arguments to determine which
        ' console stream should be used for trace output.
        If (CmdArgs.Length > 0) AndAlso _
           (CmdArgs(0).ToLower.Equals("/stderr")) Then
            ' Initialize the console trace listener to write
            ' trace output to the standard error stream.
            consoleTracer = New ConsoleTraceListener(True)
        Else
            ' Initialize the console trace listener to write
            ' trace output to the standard output stream.
            consoleTracer = New ConsoleTraceListener
        End If
        ' Set the name of the trace listener, which helps identify this 
        ' particular instance within the trace listener collection.
        consoleTracer.Name = "mainConsoleTracer"

        ' Write the initial trace message to the console trace listener.
        consoleTracer.WriteLine(DateTime.Now.ToString() & " [" & _
             consoleTracer.Name & "] - Starting output to trace listener.")

        ' Add the new console trace listener to 
        ' the collection of trace listeners.
        Trace.Listeners.Add(consoleTracer)

        ' Call a local method, which writes information about the current 
        ' execution environment to the configured trace listeners.
        WriteEnvironmentInfoToTrace()

        ' Write the final trace message to the console trace listener.
        consoleTracer.WriteLine(DateTime.Now.ToString() & " [" & _
            consoleTracer.Name & "] - Ending output to trace listener.")

        ' Flush any pending trace messages, remove the 
        ' console trace listener from the collection,
        ' and close the console trace listener.
        Trace.Flush()
        Trace.Listeners.Remove(consoleTracer)
        consoleTracer.Close()

        ' Write a final trace message to all trace listeners.
        Trace.WriteLine(DateTime.Now.ToString() + " - End of Main")

        ' Close all other configured trace listeners.
        Trace.Close()

    End Sub

End Class

注釈

クラスを ConsoleTraceListener 使用して、トレース メッセージとデバッグ メッセージをコンソールに書き込みます。 オブジェクトを初期化して、 ConsoleTraceListener トレース メッセージを Console.Out ストリームまたはストリームに Console.Error 書き込むことができます。

トレース出力とデバッグ出力が有効になっている場合、ConsoleTraceListenerメッセージは指定されたSystem.Consoleストリームに書き込まれます。これは、 メソッドまたは Console.WriteLine メソッドを使用してメッセージを書き込む方法とConsole.Write似ています。 コンソール アプリケーションでは、 System.Console 出力ストリームとエラー ストリームによって既存のコンソール ウィンドウにメッセージが書き込まれます。または、ストリームをリダイレクトしてインスタンスに System.IO.TextWriter 書き込むことができます。

、、または をConsoleTraceListener介してTraceSourceTrace書き込まれたメッセージをコンソールに書き込む場合は、適切なListenersコレクションに オブジェクトを追加Debugします。 さらに、 メソッドまたは Trace.WriteLine メソッドを使用して、コンソールに直接メッセージをTrace.Write書き込むことができます。

ほとんどのコンパイラでは、条件付きコンパイル フラグを使用してトレースとデバッグの出力を有効にします。 トレースまたはデバッグを有効にしない場合、 クラスと System.Diagnostics.Trace クラスを介してSystem.Diagnostics.Debug書き込まれたメッセージは事実上無視されます。 トレース出力とデバッグ出力を有効にする構文はコンパイラ固有です。C# または Visual Basic 以外のコンパイラを使用する場合は、コンパイラのドキュメントを参照してください。

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

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

コード内の ConsoleTraceListener コレクションに オブジェクトを Listeners 追加できます。 または、.NET Framework アプリの場合は、アプリケーション構成ファイルをConsoleTraceListener使用してコレクションに Listeners オブジェクトを追加できます。 コードに オブジェクトを ConsoleTraceListener 追加して、特定のコード セクションまたは実行パスのメッセージを書き込みます。 ConsoleTraceListenerアプリケーション構成ファイルに オブジェクトを追加して、アプリケーションの実行中にすべてのトレース メッセージとデバッグ メッセージをコンソールに転送します。

コードの特定のセクションのトレース メッセージとデバッグ メッセージをコンソールに書き込むには、オブジェクトを ConsoleTraceListener 初期化してコレクションに Listeners 追加します。 または Debug クラスを使用して、メッセージを含むコードのセクションをTraceインストルメント化します。 コード セクションの最後で、コレクションから オブジェクトをConsoleTraceListenerListeners削除し、 で メソッドをCloseConsoleTraceListener呼び出します。

.NET Framework アプリの場合、アプリケーションの実行中にすべてのトレース メッセージとデバッグ メッセージをコンソールに転送するには、アプリケーション構成ファイルに オブジェクトを追加ConsoleTraceListenerします。 次の例では、 という名前configConsoleListenerの ConsoleTraceListener オブジェクトをコレクションにListeners追加します。

<configuration>  
  <system.diagnostics>  
    <trace autoflush="false" indentsize="4">  
      <listeners>  
        <add name="configConsoleListener" type="System.Diagnostics.ConsoleTraceListener" />  
      </listeners>  
    </trace>  
  </system.diagnostics>  
 </configuration>  

アプリケーション構成ファイルにトレース リスナーを追加する方法の詳細については、「リスナー>」を参照してください<。

コンストラクター

プロパティ

メソッド

適用対象

こちらもご覧ください

• TraceListener
• TextWriterTraceListener
• Debug
• Trace
• Console