ConsoleTraceListenerとは? わかりやすく解説

ConsoleTraceListener クラス

メモ : このクラスは、.NET Framework version 2.0 で新しく追加されたものです。

トレース出力またはデバッグ出力を標準出力または標準エラー ストリームに転送します。

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

Public Class ConsoleTraceListener
    Inherits TextWriterTraceListener
Dim instance As ConsoleTraceListener
public class ConsoleTraceListener : TextWriterTraceListener
public ref class ConsoleTraceListener : public
 TextWriterTraceListener
public class ConsoleTraceListener extends TextWriterTraceListener
public class ConsoleTraceListener extends
 TextWriterTraceListener
解説解説
メモメモ

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

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

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

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

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

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

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

アプリケーション実行中にトレース メッセージおよびデバッグ メッセージをコンソールに転送するには、ConsoleTraceListener オブジェクトをアプリケーション構成ファイルに追加します。アプリケーションの名前に対応する構成ファイル、または Visual Studio 2005 プロジェクトの app.config ファイルを編集します。このファイルで、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>

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

使用例使用例

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

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

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

' 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
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
継承階層継承階層
System.Object
   System.MarshalByRefObject
     System.Diagnostics.TraceListener
       System.Diagnostics.TextWriterTraceListener
        System.Diagnostics.ConsoleTraceListener
スレッド セーフスレッド セーフ
この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。
プラットフォームプラットフォーム
バージョン情報バージョン情報
参照参照
関連項目
ConsoleTraceListener メンバ
System.Diagnostics 名前空間
TraceListener
TextWriterTraceListener
Debug
Trace
System.Console

ConsoleTraceListener コンストラクタ ()

メモ : このコンストラクタは、.NET Framework version 2.0 で新しく追加されたものです。

標準出力ストリームへのトレース出力を指定して、ConsoleTraceListener クラスの新しいインスタンスを初期化します。

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

Dim instance As New ConsoleTraceListener
public ConsoleTraceListener ()
public:
ConsoleTraceListener ()
public ConsoleTraceListener ()
public function ConsoleTraceListener ()
解説解説
使用例使用例

指定された Console 出力ストリームの ConsoleTraceListener オブジェクトを初期化して、トレース リスナ コレクションに追加するコード例を次に示します。このコード例は、ConsoleTraceListener クラスのトピックで取り上げているコード例の一部分です。

' 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)
プラットフォームプラットフォーム
バージョン情報バージョン情報
参照参照
関連項目
ConsoleTraceListener クラス
ConsoleTraceListener メンバ
System.Diagnostics 名前空間
TraceListener
DefaultTraceListener
EventLogTraceListener
TextWriterTraceListener
Console.Out
Debug
Trace

ConsoleTraceListener コンストラクタ (Boolean)

メモ : このコンストラクタは、.NET Framework version 2.0 で新しく追加されたものです。

トレース出力を標準出力ストリームまたは標準エラー ストリームに書き込むためのオプションを指定して、ConsoleTraceListener クラスの新しいインスタンスを初期化します。

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

Public Sub New ( _
    useErrorStream As Boolean _
)
Dim useErrorStream As Boolean

Dim instance As New ConsoleTraceListener(useErrorStream)
public ConsoleTraceListener (
    bool useErrorStream
)
public:
ConsoleTraceListener (
    bool useErrorStream
)
public ConsoleTraceListener (
    boolean useErrorStream
)
public function ConsoleTraceListener (
    useErrorStream : boolean
)

パラメータ

useErrorStream

トレース出力およびデバッグ出力を標準エラー ストリームに書き込む場合は true。標準出力ストリームに書き込む場合は false。

解説解説

このコンストラクタは、ConsoleTraceListener オブジェクトを初期化して、メッセージを Console.Out または Console.Error ストリームに書き込みます。Name プロパティは、空の文字列 ("") に初期化されます。

使用例使用例

指定された Console 出力ストリームの ConsoleTraceListener オブジェクトを初期化して、トレース リスナ コレクションに追加するコード例を次に示します。このコード例は、ConsoleTraceListener クラスのトピックで取り上げているコード例の一部分です。

' 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)
プラットフォームプラットフォーム
バージョン情報バージョン情報
参照参照
関連項目
ConsoleTraceListener クラス
ConsoleTraceListener メンバ
System.Diagnostics 名前空間
TraceListener
DefaultTraceListener
EventLogTraceListener
TextWriterTraceListener
System.Console
Debug
Trace

ConsoleTraceListener コンストラクタ

ConsoleTraceListener クラスの新しいインスタンスを初期化します。
オーバーロードの一覧オーバーロードの一覧

参照参照

関連項目

ConsoleTraceListener クラス
ConsoleTraceListener メンバ
System.Diagnostics 名前空間
TraceListener
DefaultTraceListener
EventLogTraceListener
TextWriterTraceListener
Console.Out
Debug
Trace

ConsoleTraceListener プロパティ


パブリック プロパティパブリック プロパティ

( プロテクト プロパティ も参照)
  名前 説明
パブリック プロパティ Attributes  アプリケーション構成ファイルに定義されているカスタム トレース リスナ属性を取得します。 ( TraceListener から継承されます。)
パブリック プロパティ Filter  トレース リスナのトレース フィルタを取得および設定します。 ( TraceListener から継承されます。)
パブリック プロパティ IndentLevel  インデントのレベルを取得または設定します。 ( TraceListener から継承されます。)
パブリック プロパティ IndentSize  1 つのインデントに含まれる空白の数を取得または設定します。 ( TraceListener から継承されます。)
パブリック プロパティ IsThreadSafe  トレース リスナがスレッド セーフかどうかを示す値を取得します。 ( TraceListener から継承されます。)
パブリック プロパティ Name  この TraceListener の名前を取得または設定します。 ( TraceListener から継承されます。)
パブリック プロパティ TraceOutputOptions  トレース出力オプションを取得または設定します。 ( TraceListener から継承されます。)
パブリック プロパティ Writer  トレース出力またはデバッグ出力を受信するテキスト ライタを取得または設定します。 ( TextWriterTraceListener から継承されます。)
プロテクト プロパティプロテクト プロパティ
  名前 説明
プロテクト プロパティ NeedIndent  出力にインデントを設定するかどうかを示す値を取得または設定します。 ( TraceListener から継承されます。)
参照参照

関連項目

ConsoleTraceListener クラス
System.Diagnostics 名前空間
TraceListener
TextWriterTraceListener
Debug
Trace
System.Console

ConsoleTraceListener メソッド


パブリック メソッドパブリック メソッド

( プロテクト メソッド も参照)
  名前 説明
パブリック メソッド Close  Writer を終了して、トレース出力またはデバッグ出力を受信しないようにします。 ( TextWriterTraceListener から継承されます。)
パブリック メソッド CreateObjRef  リモート オブジェクトとの通信に使用するプロキシの生成に必要な情報をすべて格納しているオブジェクトを作成します。 ( MarshalByRefObject から継承されます。)
パブリック メソッド Dispose  オーバーロードされます。 この TextWriterTraceListener オブジェクトを破棄します。 ( TextWriterTraceListener から継承されます。)
パブリック メソッド Equals  オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。)
パブリック メソッド Fail  オーバーロードされます。 TraceListener クラスの実装時に、作成したリスナにエラー メッセージを出力します。 ( TraceListener から継承されます。)
パブリック メソッド Flush  Writer 用の出力バッファをフラッシュします。 ( TextWriterTraceListener から継承されます。)
パブリック メソッド GetHashCode  特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。)
パブリック メソッド GetLifetimeService  対象のインスタンスの有効期間ポリシーを制御する、現在の有効期間サービス オブジェクトを取得します。 ( MarshalByRefObject から継承されます。)
パブリック メソッド GetType  現在のインスタンスの Type を取得します。 ( Object から継承されます。)
パブリック メソッド InitializeLifetimeService  対象のインスタンスの有効期間ポリシーを制御する、有効期間サービス オブジェクトを取得します。 ( MarshalByRefObject から継承されます。)
パブリック メソッド ReferenceEquals  指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
パブリック メソッド ToString  現在の Object を表す String を返します。 ( Object から継承されます。)
パブリック メソッド TraceData  オーバーロードされます。 トレース データをリスナ固有の出力に書き込みます。 ( TraceListener から継承されます。)
パブリック メソッド TraceEvent  オーバーロードされます。 トレース情報およびイベント情報をリスナ固有の出力に書き込みます。 ( TraceListener から継承されます。)
パブリック メソッド TraceTransfer  トレース情報、メッセージ、関連するアクティビティ ID、およびイベント情報をリスナ固有の出力に書き込みます。 ( TraceListener から継承されます。)
パブリック メソッド Write  オーバーロードされます。 このインスタンスの Writer にメッセージを書き込みます。 ( TextWriterTraceListener から継承されます。)
パブリック メソッド WriteLine  オーバーロードされます。 このインスタンスの Writer にメッセージを書き込み、続けて行終端記号を書き込みます。 ( TextWriterTraceListener から継承されます。)
プロテクト メソッドプロテクト メソッド
参照参照

関連項目

ConsoleTraceListener クラス
System.Diagnostics 名前空間
TraceListener
TextWriterTraceListener
Debug
Trace
System.Console

ConsoleTraceListener メンバ

トレース出力またはデバッグ出力を標準出力または標準エラー ストリームに転送します。

ConsoleTraceListener データ型で公開されるメンバを以下の表に示します。


パブリック コンストラクタパブリック コンストラクタ
  名前 説明
パブリック メソッド ConsoleTraceListener オーバーロードされます。 ConsoleTraceListener クラスの新しいインスタンスを初期化します。
パブリック プロパティパブリック プロパティ
プロテクト プロパティプロテクト プロパティ
  名前 説明
プロテクト プロパティ NeedIndent  出力にインデントを設定するかどうかを示す値を取得または設定します。(TraceListener から継承されます。)
パブリック メソッドパブリック メソッド
( プロテクト メソッド も参照)
  名前 説明
パブリック メソッド Close  Writer を終了して、トレース出力またはデバッグ出力を受信しないようにします。 (TextWriterTraceListener から継承されます。)
パブリック メソッド CreateObjRef  リモート オブジェクトとの通信に使用するプロキシの生成に必要な情報をすべて格納しているオブジェクトを作成します。 (MarshalByRefObject から継承されます。)
パブリック メソッド Dispose  オーバーロードされます。 この TextWriterTraceListener オブジェクトを破棄します。 (TextWriterTraceListener から継承されます。)
パブリック メソッド Equals  オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。)
パブリック メソッド Fail  オーバーロードされます。 TraceListener クラスの実装時に、作成したリスナにエラー メッセージを出力します。 (TraceListener から継承されます。)
パブリック メソッド Flush  Writer 用の出力バッファをフラッシュします。 (TextWriterTraceListener から継承されます。)
パブリック メソッド GetHashCode  特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 (Object から継承されます。)
パブリック メソッド GetLifetimeService  対象のインスタンスの有効期間ポリシーを制御する、現在の有効期間サービス オブジェクトを取得します。 (MarshalByRefObject から継承されます。)
パブリック メソッド GetType  現在のインスタンスの Type を取得します。 (Object から継承されます。)
パブリック メソッド InitializeLifetimeService  対象のインスタンスの有効期間ポリシーを制御する、有効期間サービス オブジェクトを取得します。 (MarshalByRefObject から継承されます。)
パブリック メソッド ReferenceEquals  指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
パブリック メソッド ToString  現在の Object を表す String を返します。 (Object から継承されます。)
パブリック メソッド TraceData  オーバーロードされます。 トレース データをリスナ固有の出力に書き込みます。 (TraceListener から継承されます。)
パブリック メソッド TraceEvent  オーバーロードされます。 トレース情報およびイベント情報をリスナ固有の出力に書き込みます。 (TraceListener から継承されます。)
パブリック メソッド TraceTransfer  トレース情報、メッセージ、関連するアクティビティ ID、およびイベント情報をリスナ固有の出力に書き込みます。 (TraceListener から継承されます。)
パブリック メソッド Write  オーバーロードされます。 このインスタンスの Writer にメッセージを書き込みます。 (TextWriterTraceListener から継承されます。)
パブリック メソッド WriteLine  オーバーロードされます。 このインスタンスの Writer にメッセージを書き込み、続けて行終端記号を書き込みます。 (TextWriterTraceListener から継承されます。)
プロテクト メソッドプロテクト メソッド
参照参照

関連項目

ConsoleTraceListener クラス
System.Diagnostics 名前空間
TraceListener
TextWriterTraceListener
Debug
Trace
System.Console



英和和英テキスト翻訳

英語⇒日本語日本語⇒英語

辞書ショートカット

すべての辞書の索引

「ConsoleTraceListener」の関連用語

ConsoleTraceListenerのお隣キーワード
検索ランキング

   

英語⇒日本語
日本語⇒英語
   



ConsoleTraceListenerのページの著作権

   
日本マイクロソフト株式会社日本マイクロソフト株式会社
© 2026 Microsoft.All rights reserved.

©2026 GRAS Group, Inc.RSS