TraceFilter.ShouldTrace Metoda

Definice

Obor názvů:

System.Diagnostics

Sestavení:

netstandard.dll, System.Diagnostics.TraceSource.dll

Zdroj:

TraceFilter.cs

Při přepsání v odvozené třídě určuje, zda naslouchací proces trasování má trasovat událost.

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

public abstract bool ShouldTrace(System.Diagnostics.TraceEventCache? cache, string source, System.Diagnostics.TraceEventType eventType, int id, string? formatOrMessage, object?[]? args, object? data1, object?[]? data);

abstract member ShouldTrace : System.Diagnostics.TraceEventCache * string * System.Diagnostics.TraceEventType * int * string * obj[] * obj * obj[] -> bool

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

Parametry

cache

TraceEventCache

Obsahuje TraceEventCache informace o události trasování.

source

String

Název zdroje.

eventType

TraceEventType

Jedna z TraceEventType hodnot určujících typ události, která způsobila trasování.

id

Int32

Číslo identifikátoru trasování.

formatOrMessage

String

Formát, který se má použít pro zápis pole argumentů určených parametrem args , nebo zprávu k zápisu.

args

Object[]

Pole objektů argumentů.

data1

Object

Datový objekt trasování.

data

Object[]

Pole datových objektů trasování.

Návraty

Boolean

truetrasování zadané události; v opačném případě . false

Příklady

Následující příklad kódu ukazuje, jak přepsat metodu ShouldTrace označující trasování by mělo dojít, když je typ události trasování události rovna TraceEventType.Error.

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

Public Class ErrorFilter
    Inherits TraceFilter

    Public Overrides Function ShouldTrace ( cache As TraceEventCache, _
                source As String, eventType As TraceEventType, _
                id As Integer, formatOrMessage As String, _
                args As Object(), data As Object, _
                dataArray As Object() ) As Boolean
        If eventType = TraceEventType.Error Then
            Return True
        Else
            Return False
        End If
    End Function
End Class

Poznámky pro implementátory

Implementace této metody by se měly vrátit true , pokud by měla být trasována událost určená předávanými parametry. Jinak by metoda měla vrátit false. Filtr, který například umožňuje průchod pouze chybovým událostem do naslouchacího procesu, by měl zkontrolovat eventType parametr a vrátit true , pokud je úroveň typu události trasování nastavena Error nebo vyšší. V opačném případě by se měla vrátit false.

Implementace metody by měly být připraveny na zpracování null v následujících parametrech: args, data1, dataformatOrMessagea cache. Pokud je nullhodnota parametru , parametr není součástí události. Pokud je argsparametr například null , znamená to, že událost nemá žádné argumenty. data Pokud je nullparametr , existuje jeden nebo žádný datový objekt. Pokud existuje jeden datový objekt, najdete ho v parametru data1 . Důvodem rozdílu mezi jedním datovým objektem a polem datových objektů je výkon. Neexistuje důvod k vytvoření pole objektů, pokud je trasován pouze jeden objekt, jak je tomu obvykle. data Pokud parametr není null, data1 parametr nesmí být nulltaké .

Zaručuje se, že source parametr není null prázdný řetězec ("").

Implementace metody mohou volitelně vyvolat následující výjimky:

• ArgumentNullException pokud source je null.

• ArgumentException pokud eventType není jedna z TraceEventType hodnot.

• Výjimky nesouvisející s implementací metody. Například .ThreadAbortException