TraceFilter.ShouldTrace メソッド

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

TraceFilter.ShouldTrace メソッド

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

派生クラスでのオーバーライドの際に、トレース リスナでイベントをトレースするかどうかを決定します。

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

Visual Basic (宣言)

Public MustOverride Function
 ShouldTrace ( _
    cache As TraceEventCache, _
    source As String, _
    eventType As TraceEventType, _
    id As Integer, _
    formatOrMessage As String, _
    args As Object(), _
    data1 As Object, _
    data As Object() _
) As Boolean

Visual Basic (使用法)

Dim instance As TraceFilter
Dim cache As TraceEventCache
Dim source As String
Dim eventType As TraceEventType
Dim id As Integer
Dim formatOrMessage As String
Dim args As Object()
Dim data1 As Object
Dim data As Object()
Dim returnValue As Boolean

returnValue = instance.ShouldTrace(cache, source, eventType, id, formatOrMessage,
 args, data1, data)

C#

public abstract bool ShouldTrace (
    TraceEventCache cache,
    string source,
    TraceEventType eventType,
    int id,
    string formatOrMessage,
    Object[] args,
    Object data1,
    Object[] data
)

C++

public:
virtual bool ShouldTrace (
    TraceEventCache^ cache, 
    String^ source, 
    TraceEventType eventType, 
    int id, 
    String^ formatOrMessage, 
    array<Object^>^ args, 
    Object^ data1, 
    array<Object^>^ data
) abstract

J#

public abstract boolean ShouldTrace (
    TraceEventCache cache, 
    String source, 
    TraceEventType eventType, 
    int id, 
    String formatOrMessage, 
    Object[] args, 
    Object data1, 
    Object[] data
)

JScript

public abstract function ShouldTrace (
    cache : TraceEventCache, 
    source : String, 
    eventType : TraceEventType, 
    id : int, 
    formatOrMessage : String, 
    args : Object[], 
    data1 : Object, 
    data : Object[]
) : boolean

パラメータ

cache

トレース イベントの情報を含む TraceEventCache。

source

ソースの名前。

eventType

トレースを発生させたイベントの種類を指定する TraceEventType 値の 1 つ。

id

トレース識別子番号。

formatOrMessage

args パラメータによって指定された引数の配列を書き込むために使用する書式、または書き込むメッセージ。

args

引数オブジェクトの配列。

data1

トレース データ オブジェクト。

data

トレース データ オブジェクトの配列。

戻り値
指定したイベントをトレースする場合は true。それ以外の場合は false。

解説

継承時の注意 このメソッドの実装は、受け取ったパラメータによって指定されたイベントをトレースする場合に true を返します。それ以外の場合、メソッドは false を返します。たとえば、リスナにエラー イベントのみを渡すフィルタは、eventType パラメータを検査し、トレース イベントの種類のレベルが TraceEventType.Error 以上に設定されている場合は true を返します。それ以外の場合は false を返します。 メソッドの実装は、args、data1、data、formatOrMessage、および cache の各パラメータで null 参照 (Visual Basic では Nothing) を処理できるようにする必要があります。パラメータ値が null 参照 (Visual Basic では Nothing) の場合、パラメータはイベントの一部ではありません。たとえば、args パラメータが null 参照 (Visual Basic では Nothing) である場合は、イベントに引数がないことを示しています。data パラメータが null 参照 (Visual Basic では Nothing) である場合は、データ オブジェクトがないか、または 1 つだけあることを示しています。データ オブジェクトが 1 つの場合は、data1 パラメータに含まれています。単一のデータ オブジェクトとデータ オブジェクトの配列を区別する理由はパフォーマンスにあります。1 つのオブジェクトのみをトレースする場合は、通常どおりにオジェクト配列を作成する必要はありません。data パラメータが null 参照 (Visual Basic では Nothing) でない場合、data1 パラメータも null 参照 (Visual Basic では Nothing) 以外にする必要があります。 source パラメータは、null 参照 (Visual Basic では Nothing) でも空の文字列 ("") でもないことが保証されています。 メソッドの実装により、必要に応じて次の例外をスローします。

• source が null 参照 (Visual Basic では Nothing) の場合は ArgumentNullException。

• eventType が TraceEventType 値の 1 つでない場合は、ArgumentException。

• メソッドの実装に関連しない例外。たとえば、ThreadAbortException などです。

使用例

イベントについて、トレース イベントの種類が TraceEventType.Error に等しい場合にトレースが発生することを示す ShouldTrace メソッドをオーバーライドする方法を次のコード例に示します。

C#

public class ErrorFilter : TraceFilter
{
    public bool ShouldTrace(TraceEventCache
 cache, string source, 
        TraceEventType eventType, int id, string
 formatOrMessage,
        object[] args, object data, object[] dataArray)
        
        return eventType == TraceEventType.Error;
    }
}

プラットフォーム

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 によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
TraceFilter クラス
TraceFilter メンバ
System.Diagnostics 名前空間