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

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

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

DefaultTraceListener クラス

トレースの既定の出力メソッドおよび動作を提供します。

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

Visual Basic (宣言)

Public Class DefaultTraceListener
    Inherits TraceListener

Visual Basic (使用法)

Dim instance As DefaultTraceListener

public class DefaultTraceListener : TraceListener

C++

public ref class DefaultTraceListener : public
 TraceListener

public class DefaultTraceListener extends TraceListener

JScript

public class DefaultTraceListener extends
 TraceListener

解説

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

メモ

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

このクラスのインスタンスは、Debug.Listeners コレクションおよび Trace.Listeners コレクションに自動的に追加されます。2 番目の DefaultTraceListener を明示的に追加すると、デバッガの出力ウィンドウに重複するメッセージが表示され、アサート用の重複するメッセージボックスが表示されます。

既定では、Write メソッドおよび WriteLine メソッドは、Win32 OutputDebugString 関数と Debugger.Log メソッドにメッセージを出力します。OutputDebugString 関数については、プラットフォーム SDK または MSDN を参照してください。

既定では、Fail メソッドはメッセージボックスを表示します (アプリケーションがユーザーインターフェイスモードで実行されているとき)。また、WriteLine を使用してメッセージを出力します。

トレースリスナを使用するには、トレースまたはデバッグを有効にする必要があります。次の構文はコンパイラに固有です。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>
      <remove name="Default" />
      <add name="myListener"  type="System.Diagnostics.TextWriterTraceListener"
    initializeData="c:\myListener.log" />
    </listeners>
  </trace>
</system.diagnostics>
</configuration>

使用例

確率統計学で使用される値の二項係数を計算するコード例を次に示します。この例では、DefaultTraceListener を使用して結果をトレースし、エラーのログを記録します。新しい DefaultTraceListener を作成し、Trace.Listeners コレクションに追加し、LogFileName プロパティをコマンドライン引数で指定されたログファイルに設定します。

入力パラメータの処理中にエラーが検出されるか、または CalcBinomial 関数によって例外がスローされた場合、Fail メソッドはエラーメッセージのログを記録し、エラーメッセージを表示します。AssertUiEnabled プロパティが false の場合は、コンソールにエラーメッセージも書き込まれます。結果が正しく計算されると、Write(String) メソッドおよび WriteLine(String) メソッドは結果をログファイルに書き込みます。

Fail メソッド、Write メソッド、および WriteLine メソッドは、トレース情報を DefaultTraceListener だけに書き込みます。トレースについての情報を Trace.Listeners コレクションのすべてのリスナに書き込むには、Trace クラスの Fail メソッド、Write メソッド、および WriteLine メソッドを使用します。

Visual Basic

Imports System
Imports System.Diagnostics
Imports Microsoft.VisualBasic

Module Binomial

    ' args(0) is the number of possibilities for binomial coefficients.
    ' args(1) is the file specification for the trace log file.
    Sub Main(ByVal args() As
 String)

        Dim possibilities As Decimal
        Dim iter As Decimal

        ' Remove the original default trace listener.
        Trace.Listeners.RemoveAt(0)

        ' Create and add a new default trace listener.
        Dim defaultListener As DefaultTraceListener
        defaultListener = New DefaultTraceListener
        Trace.Listeners.Add(defaultListener)

        ' Assign the log file specification from the command line, if
 entered.
        If args.Length >= 2 Then
            defaultListener.LogFileName = args(1)
        End If

        ' Validate the number of possibilities argument.
        If args.Length >= 1 Then

            ' Verify that the argument is a number within the correct
 range.
            Try
                Const MAX_POSSIBILITIES As
 Decimal = 99
                possibilities = Decimal.Parse(args(0))
                If possibilities < 0 Or
 possibilities > MAX_POSSIBILITIES Then
                    Throw New Exception( _
                        String.Format("The
 number of possibilities must " & _
                            "be in the range 0..{0}.",
 MAX_POSSIBILITIES))
                End If
            Catch ex As Exception
                Dim failMessage As String
 = String.Format("""{0}""
 " & _
                    "is not a valid number of possibilities.",
 args(0))
                defaultListener.Fail(failMessage, ex.Message)
                If Not defaultListener.AssertUiEnabled
 Then
                    Console.WriteLine(failMessage & vbCrLf & ex.Message)
                End If
                Return
            End Try
        Else
            ' Report that the required argument is not present.
            Const ENTER_PARAM As String
 = "Enter the number of " & _
                "possibilities as a command line argument."
            defaultListener.Fail(ENTER_PARAM)
            If Not defaultListener.AssertUiEnabled
 Then
                Console.WriteLine(ENTER_PARAM)
            End If
            Return
        End If

        For iter = 0 To possibilities
            Dim result As Decimal
            Dim binomial As String

            ' Compute the next binomial coefficient and handle all exceptions.
            Try
                result = CalcBinomial(possibilities, iter)
            Catch ex As Exception
                Dim failMessage As String
 = String.Format( _
                        "An exception was raised when "
 & _
                        "calculating Binomial( {0}, {1} ).",
 _
                        possibilities, iter)
                defaultListener.Fail(failmessage, ex.Message)
                If Not defaultListener.AssertUiEnabled
 Then
                    Console.WriteLine(failMessage & vbCrLf & ex.Message)
                End If
                Return
            End Try

            ' Format the trace and console output.
            binomial = String.Format("Binomial(
 {0}, {1} ) = ", _
                            possibilities, iter)
            defaultListener.Write(binomial)
            defaultListener.WriteLine(result.ToString)
            Console.WriteLine("{0} {1}", binomial,
 result)
        Next
    End Sub

    Function CalcBinomial(ByVal possibilities
 As Decimal, _
                        ByVal outcomes As Decimal)
 As Decimal

        ' Calculate a binomial coefficient, and minimize the chance
 of overflow.
        Dim result As Decimal
 = 1
        Dim iter As Decimal
        For iter = 1 To possibilities - outcomes
            result *= outcomes + iter
            result /= iter
        Next
        Return result
    End Function
End Module