TraceFilter.ShouldTrace Metoda

Reference

Definice

Obor názvů:: System.Diagnostics

Sestavení:: System.Diagnostics.TraceSource.dll

Sestavení:: System.dll

Sestavení:: netstandard.dll

Důležité

Některé informace platí pro předběžně vydaný produkt, který se může zásadně změnit, než ho výrobce nebo autor vydá. Microsoft neposkytuje žádné záruky, výslovné ani předpokládané, týkající se zde uváděných informací.

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

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);

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 args parametrem, nebo zprávu k zápisu.

args: Object[]

Pole objektů argumentů.

data1: Object

Objekt dat trasování.

data: Object[]

Pole datových objektů trasování

Návraty

Boolean

true trasování zadané události; falsev opačném případě .

Příklady

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

public ref class ErrorFilter : TraceFilter
{
public:
    virtual bool ShouldTrace(TraceEventCache^ cache, String^ source,
        TraceEventType eventType, int id, String^ formatOrMessage,
        array<Object^>^ args, Object^ data, array<Object^>^ dataArray) override
    {
        return eventType == 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 zadaná 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 se, pokud je úroveň typu události trasování nastavena nebo Error vyšší. V opačném případě by se měla vrátit false.

Implementace metody by měly být připraveny pro zpracování null v následujících parametrech: args, , data1data, formatOrMessage, a cache. Pokud je nullhodnota parametru , parametr není součástí události. Pokud args je nullparametr například , znamená to, že událost nemá žádné argumenty. data Pokud je nullparametr , existují buď jeden, nebo žádné datové objekty. 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. Není důvod vytvořit pole objektů, pokud je trasován pouze jeden objekt, stejně jako obvykle. Pokud parametr data není null, data1 nesmí být parametr také null.

Je zaručeno, ž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

Platí pro