ConsoleTraceListener クラス
アセンブリ: System (system.dll 内)


![]() |
---|
このクラスに適用される 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 メソッドを使用することにより、メッセージをコンソールに直接書き込むこともできます。
![]() |
---|
Debug クラスおよび Trace クラスは、それぞれの Listeners プロパティを使用してアクセスできる、同じ TraceListenerCollection コレクションを共有します。いずれかのクラスを使用して ConsoleTraceListener オブジェクトをコレクションに追加した場合、もう 1 つのクラスは自動的に同じリスナを使用します。 |
ほとんどのコンパイラは、条件付きコンパイル フラグを使用してトレース出力およびデバッグ出力を有効にします。トレースおよびデバッグを有効にしなかった場合、System.Diagnostics.Debug クラスおよび System.Diagnostics.Trace クラスを使用して書き込まれたメッセージは、事実上無視されます。トレース出力およびデバッグ出力を有効にする構文はコンパイラ固有です。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 コレクションに追加したり、アプリケーション構成ファイルで 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.MarshalByRefObject
System.Diagnostics.TraceListener
System.Diagnostics.TextWriterTraceListener
System.Diagnostics.ConsoleTraceListener


Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。


ConsoleTraceListener コンストラクタ ()
アセンブリ: System (system.dll 内)


このコンストラクタは ConsoleTraceListener オブジェクトを初期化して、メッセージを Console.Out ストリームに書き込みます。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)

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。


ConsoleTraceListener コンストラクタ (Boolean)
アセンブリ: System (system.dll 内)


このコンストラクタは、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)

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。


ConsoleTraceListener コンストラクタ

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

ConsoleTraceListener プロパティ

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


関連項目
ConsoleTraceListener クラスSystem.Diagnostics 名前空間
TraceListener
TextWriterTraceListener
Debug
Trace
System.Console
ConsoleTraceListener メソッド


名前 | 説明 | |
---|---|---|
![]() | Dispose | オーバーロードされます。 この TextWriterTraceListener オブジェクトを破棄します。 ( TextWriterTraceListener から継承されます。) |
![]() | Finalize | Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。) |
![]() | GetSupportedAttributes | トレース リスナによってサポートされるカスタム属性を取得します。 ( TraceListener から継承されます。) |
![]() | MemberwiseClone | オーバーロードされます。 ( MarshalByRefObject から継承されます。) |
![]() | WriteIndent | このクラスの実装時に作成したリスナにインデントを書き込み、NeedIndent プロパティを false にリセットします。 ( TraceListener から継承されます。) |

関連項目
ConsoleTraceListener クラスSystem.Diagnostics 名前空間
TraceListener
TextWriterTraceListener
Debug
Trace
System.Console
ConsoleTraceListener メンバ
トレース出力またはデバッグ出力を標準出力または標準エラー ストリームに転送します。
ConsoleTraceListener データ型で公開されるメンバを以下の表に示します。


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



名前 | 説明 | |
---|---|---|
![]() | Dispose | オーバーロードされます。 この TextWriterTraceListener オブジェクトを破棄します。 (TextWriterTraceListener から継承されます。) |
![]() | Finalize | Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。) |
![]() | GetSupportedAttributes | トレース リスナによってサポートされるカスタム属性を取得します。 (TraceListener から継承されます。) |
![]() | MemberwiseClone | オーバーロードされます。 ( MarshalByRefObject から継承されます。) |
![]() | WriteIndent | このクラスの実装時に作成したリスナにインデントを書き込み、NeedIndent プロパティを false にリセットします。 (TraceListener から継承されます。) |

関連項目
ConsoleTraceListener クラスSystem.Diagnostics 名前空間
TraceListener
TextWriterTraceListener
Debug
Trace
System.Console
- ConsoleTraceListenerのページへのリンク