XmlWriterTraceListener Třída

Definice

Směruje trasování nebo ladění výstupu jako data zakódovaná ve formátu XML do TextWriter nebo do, jako je například Stream FileStream .Directs tracing or debugging output as XML-encoded data to a TextWriter or to a Stream, such as a FileStream.

public ref class XmlWriterTraceListener : System::Diagnostics::TextWriterTraceListener
public class XmlWriterTraceListener : System.Diagnostics.TextWriterTraceListener
type XmlWriterTraceListener = class
    inherit TextWriterTraceListener
Public Class XmlWriterTraceListener
Inherits TextWriterTraceListener
Dědičnost

Příklady

Následující příklad kódu ukazuje použití XmlWriterTraceListener třídy k zápisu řídicích a neřídicích dat do protokolů souborů.The following code example shows the use of the XmlWriterTraceListener class to write both escaped and non-escaped data to file logs.

using System;
using System.IO;
using System.Xml;
using System.Xml.XPath;
using System.Diagnostics;

class testClass
{
    static void Main()
    {
        File.Delete("NotEscaped.xml");
        TraceSource ts = new TraceSource("TestSource");
        ts.Listeners.Add(new XmlWriterTraceListener("NotEscaped.xml"));
        ts.Switch.Level = SourceLevels.All;
        string testString = "<Test><InnerElement Val=\"1\" /><InnerElement Val=\"Data\"/><AnotherElement>11</AnotherElement></Test>";
        XmlTextReader myXml = new XmlTextReader(new StringReader(testString));
        XPathDocument xDoc = new XPathDocument(myXml);
        XPathNavigator myNav = xDoc.CreateNavigator();
        ts.TraceData(TraceEventType.Error, 38, myNav);

        ts.Flush();
        ts.Close();

        File.Delete("Escaped.xml");
        TraceSource ts2 = new TraceSource("TestSource2");
        ts2.Listeners.Add(new XmlWriterTraceListener("Escaped.xml"));
        ts2.Switch.Level = SourceLevels.All;
        ts2.TraceData(TraceEventType.Error, 38, testString);

        ts2.Flush();
        ts2.Close();
    }
}
Imports System.IO
Imports System.Xml
Imports System.Xml.XPath
Imports System.Diagnostics



Class testClass
    
    Shared Sub Main() 
        File.Delete("NotEscaped.xml")
        Dim ts As New TraceSource("TestSource")
        ts.Listeners.Add(New XmlWriterTraceListener("NotEscaped.xml"))
        ts.Switch.Level = SourceLevels.All
        Dim testString As String = "<Test><InnerElement Val=""1"" /><InnerElement Val=""Data""/><AnotherElement>11</AnotherElement></Test>"
        Dim myXml As New XmlTextReader(New StringReader(testString))
        Dim xDoc As New XPathDocument(myXml)
        Dim myNav As XPathNavigator = xDoc.CreateNavigator()
        ts.TraceData(TraceEventType.Error, 38, myNav)

        ts.Flush()
        ts.Close()
        
        File.Delete("Escaped.xml")
        Dim ts2 As New TraceSource("TestSource2")
        ts2.Listeners.Add(New XmlWriterTraceListener("Escaped.xml"))
        ts2.Switch.Level = SourceLevels.All
        ts2.TraceData(TraceEventType.Error, 38, testString)
        
        ts2.Flush()
        ts2.Close()
    
    End Sub
End Class

Poznámky

Poznámka

Chcete-li vytvořit instanci třídy, musíte mít oprávnění nespravovaného kódu XmlWriterTraceListener .You must have unmanaged code permission to create an instance of the XmlWriterTraceListener class.

XmlWriterTraceListenerTřída převede informace o trasování a ladění do textového streamu kódovaného XML.The XmlWriterTraceListener class converts tracing and debugging information into an XML-encoded text stream. Popis výstupu XML je zobrazen v tabulkách, které následují.The description of the XML output is shown in the tables that follow. Výstup XML můžete zobrazit pomocí nástroje Service Trace Viewer (SvcTraceViewer.exe) .You can use the Service Trace Viewer Tool (SvcTraceViewer.exe) to display the XML output.

Můžete povolit nebo zakázat XmlWriterTraceListener prostřednictvím konfiguračního souboru aplikace a potom použít nakonfigurovanou XmlWriterTraceListener aplikaci.You can enable or disable an XmlWriterTraceListener through the application configuration file and then use the configured XmlWriterTraceListener in your application. Alternativně můžete vytvořit XmlWriterTraceListener ve svém kódu.Alternately, you can create an XmlWriterTraceListener in your code.

Chcete-li nakonfigurovat XmlWriterTraceListener , upravte konfigurační soubor, který odpovídá názvu vaší aplikace.To configure an XmlWriterTraceListener, edit the configuration file that corresponds to the name of your application. V tomto souboru můžete přidat nebo odebrat naslouchací proces, nastavit vlastnosti naslouchacího procesu nebo odebrat naslouchací procesy.In this file, you can add or remove a listener, set the properties for a listener, or remove listeners. Konfigurační soubor by měl být naformátován podobně jako v následujícím příkladu.The configuration file should be formatted like the following example.

<configuration>  
  <system.diagnostics>  
    <trace autoflush="false" indentsize="4">  
      <listeners>  
        <add name="xmlListener"   
          type="System.Diagnostics.XmlWriterTraceListener"   
          initializeData="xmlOutput.xml"   
          traceOutputOptions="ProcessId, DateTime" />  
        <remove name="Default" />  
      </listeners>  
    </trace>  
  </system.diagnostics>  
</configuration>  

XmlWriterTraceListenerTřída dědí Filter vlastnost ze základní třídy TraceListener .The XmlWriterTraceListener class inherits the Filter property from the base class TraceListener. FilterVlastnost umožňuje další úroveň filtrování výstupu trasování v naslouchací službě.The Filter property allows an additional level of trace output filtering at the listener. Pokud je přítomen filtr, Trace metody naslouchacího procesu trasování volají ShouldTrace metodu filtru k určení, zda se má trasování generovat.If there is a filter present, the Trace methods of the trace listener call the ShouldTrace method of the filter to determine whether to emit the trace.

Poznámka

Pokud je proveden pokus o zápis do souboru, který je používán nebo není k dispozici, název souboru je automaticky předponou identifikátorem GUID.If an attempt is made to write to a file that is in use or unavailable, the file name is automatically prefixed by a GUID.

Poznámka

Metody naslouchacího procesu jsou určeny pro volání metody Debug Trace třídy, a TraceSource .Listener methods are intended to be called by methods of the Debug, Trace, and TraceSource classes. Metody naslouchacího procesu nejsou určeny pro volání přímo z kódu aplikace.The listener methods are not intended to be called directly from application code. XmlWriterTraceListenerNaslouchací proces je primárně určen pro použití TraceSource třídou.The XmlWriterTraceListener listener is primarily intended for use by the TraceSource class. WriteMetody a WriteLine mohou být volány Trace Debug třídami a a výchozí hodnoty jsou k dispozici pro elementy XML, které Trace Debug neposkytují hodnoty pro.The Write and WriteLine methods can be called by the Trace and Debug classes, and default values are provided for the XML elements that Trace and Debug do not supply values for.

Následující tabulka popisuje elementy a atributy výstupu XML.The following table describes the elements and attributes of the XML output.

PrvekElement AtributyAttributes VýstupOutput PoznámkyNotes
CallStack ŽádnéNone Závisí na přítomnosti Callstack příznaku ve TraceOutputOptions Vlastnosti.Depends on the presence of the Callstack flag in the TraceOutputOptions property. Speciální znaky, například > nebo <, jsou nahrazeny řídicími sekvencemi.Special characters such as > or < are replaced with escape sequences. Podívejte se na následující tabulku s řídicím znakem pro posunutí.See the escaped character translation table that follows.
Computer ŽádnéNone Vždy přítomen.Always present. Hodnota MachineName vlastnostiThe value of the MachineName property.
Correlation ActivityID Vždy přítomenAlways present Pokud není zadán, výchozí hodnota je prázdný identifikátor GUID.If not specified, the default is an empty GUID.
RelatedActivityID Závisí na přítomnosti relatedActivityId parametru ve volání metody Trace.Depends on the presence of the relatedActivityId parameter in the Trace method call. relatedActivityIdParametr TraceTransfer metodyThe relatedActivityId parameter of the TraceTransfer method.
DataItem ŽádnéNone Závisí na data parametru TraceData metody.Depends on the data parameter of the TraceData method. Tento prvek může obsahovat pole prvků nebo jeden prvek, takže hodnoty jsou zapsány jako sada DataItem uzlů pod TraceData prvkem.This element can contain an array of elements or one element, so the values are written as a set of DataItem nodes under the TraceData element.

Výstup dat používá ToString metodu předaných datových objektů.The data output uses the ToString method of the passed-in data objects.
EventID ŽádnéNone Vždy přítomen.Always present. Vstup parametru ( id ).Parameter input (id).
Execution ProcessName Vždy přítomen.Always present. Z TraceEventCache .From the TraceEventCache.
ProcessID Vždy přítomen.Always present. Z TraceEventCache .From the TraceEventCache.
ThreadID Vždy přítomen.Always present. Z TraceEventCache .From the TraceEventCache.
Level ŽádnéNone Vždy přítomen.Always present. Vstup parametru (číselná hodnota eventType ).Parameter input (the numeric value of eventType). Hodnoty parametrů větší než 255 jsou výstupem jako 255.Parameter values greater than 255 are output as 255.
LogicalOperationStack ŽádnéNone Závisí na přítomnosti LogicalOperationStack příznaku ve TraceOutputOptions Vlastnosti.Depends on the presence of the LogicalOperationStack flag in the TraceOutputOptions property. Může existovat více než jedna logická operace, takže hodnoty jsou zapsány jako LogicalOperation uzly pod LogicalOperationStack prvkem.There can be more than one logical operation, so the values are written as LogicalOperation nodes under the LogicalOperationStack element.
Message ŽádnéNone Závisí na přítomnosti zprávy ve volání metody Trace.Depends on the presence of a message in the Trace method call. Tento prvek je formátovaná zpráva, pokud jsou zadány formátovací argumenty.This element is a formatted message if formatting arguments are provided.
Source Name Vždy přítomen.Always present. Vstup parametru.Parameter input.
SubType Name Vždy přítomen.Always present. Vstup parametru.Parameter input.
TimeCreated SystemTime Vždy přítomen.Always present. Pokud není k dispozici v TraceEventCache , výchozí hodnota je aktuální čas.If not present in the TraceEventCache, the default is the current time.
TimeStamp ŽádnéNone Závisí na přítomnosti Timestamp příznaku ve TraceOutputOptions Vlastnosti.Depends on the presence of the Timestamp flag in the TraceOutputOptions property. Z TraceEventCache .From the TraceEventCache.
Type ŽádnéNone Vždy přítomen.Always present. Vždy hodnota 3.Always the value 3.

V následující tabulce jsou uvedeny znaky, které jsou uvozeny ve výstupu XML.The following table shows the characters that are escaped in the XML output. K uvozovacímu výrazu dochází ve všech prvcích a atributech s výjimkou DataItem elementu, který není řídící, pokud je objekt předaný data parametru TraceData metody XPathNavigator objekt.Escaping occurs in all the elements and attributes with the exception of the DataItem element, which is not escaped if the object passed to the data parameter of the TraceData method is an XPathNavigator object. Pokud XPathNavigator se používá pro datový objekt, MoveToRoot je volána metoda a celý kořenový uzel je sledován jako neřídicí data.If an XPathNavigator is used for the data object, the MoveToRoot method is called and the entire root node is traced as unescaped data.

Řídicí znakEscaped character HodnotaValue
& &
< <
> >
"" "
|'
0xD0xD &#xD&#xD;
0xA0xA &#Protokol&#xA;

Konstruktory

XmlWriterTraceListener(Stream)

Inicializuje novou instanci XmlWriterTraceListener třídy pomocí zadaného datového proudu jako příjemce výstupu ladění a trasování.Initializes a new instance of the XmlWriterTraceListener class, using the specified stream as the recipient of the debugging and tracing output.

XmlWriterTraceListener(Stream, String)

Inicializuje novou instanci XmlWriterTraceListener třídy se zadaným názvem a použije zadaný datový proud jako příjemce výstupu ladění a trasování.Initializes a new instance of the XmlWriterTraceListener class with the specified name, using the specified stream as the recipient of the debugging and tracing output.

XmlWriterTraceListener(String)

Inicializuje novou instanci XmlWriterTraceListener třídy pomocí zadaného souboru jako příjemce výstupu ladění a trasování.Initializes a new instance of the XmlWriterTraceListener class, using the specified file as the recipient of the debugging and tracing output.

XmlWriterTraceListener(String, String)

Inicializuje novou instanci XmlWriterTraceListener třídy se zadaným názvem, pomocí zadaného souboru jako příjemce výstupu ladění a trasování.Initializes a new instance of the XmlWriterTraceListener class with the specified name, using the specified file as the recipient of the debugging and tracing output.

XmlWriterTraceListener(TextWriter)

Inicializuje novou instanci XmlWriterTraceListener třídy pomocí zadaného zapisovače jako příjemce výstupu ladění a trasování.Initializes a new instance of the XmlWriterTraceListener class using the specified writer as the recipient of the debugging and tracing output.

XmlWriterTraceListener(TextWriter, String)

Inicializuje novou instanci XmlWriterTraceListener třídy se zadaným názvem a pomocí zadaného zapisovače jako příjemce výstupu ladění a trasování.Initializes a new instance of the XmlWriterTraceListener class with the specified name, using the specified writer as the recipient of the debugging and tracing output.

Vlastnosti

Attributes

Získá vlastní atributy naslouchacího procesu trasování definované v konfiguračním souboru aplikace.Gets the custom trace listener attributes defined in the application configuration file.

(Zděděno od TraceListener)
Filter

Získá nebo nastaví filtr trasování pro naslouchací proces trasování.Gets or sets the trace filter for the trace listener.

(Zděděno od TraceListener)
IndentLevel

Získá nebo nastaví úroveň odsazení.Gets or sets the indent level.

(Zděděno od TraceListener)
IndentSize

Získá nebo nastaví počet mezer v odsazení.Gets or sets the number of spaces in an indent.

(Zděděno od TraceListener)
IsThreadSafe

Načte hodnotu, která označuje, zda je naslouchací proces trasování bezpečný pro přístup z více vláken.Gets a value indicating whether the trace listener is thread safe.

(Zděděno od TraceListener)
Name

Získá nebo nastaví název pro tuto hodnotu TraceListener .Gets or sets a name for this TraceListener.

(Zděděno od TraceListener)
NeedIndent

Získá nebo nastaví hodnotu označující, zda má být výstup odsazen.Gets or sets a value indicating whether to indent the output.

(Zděděno od TraceListener)
TraceOutputOptions

Získá nebo nastaví možnosti výstupu trasování.Gets or sets the trace output options.

(Zděděno od TraceListener)
Writer

Získá nebo nastaví zapisovač textu, který přijímá výstup trasování nebo ladění.Gets or sets the text writer that receives the tracing or debugging output.

(Zděděno od TextWriterTraceListener)

Metody

Close()

Ukončí Writer pro tento naslouchací proces, aby už nepřijímal trasování nebo ladění výstupu.Closes the Writer for this listener so that it no longer receives tracing or debugging output.

CreateObjRef(Type)

Vytvoří objekt, který obsahuje všechny relevantní informace požadované pro vygenerování proxy serveru, který se používá ke komunikaci se vzdáleným objektem.Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.

(Zděděno od MarshalByRefObject)
Dispose()

Uvolní všechny prostředky, které používá TraceListener .Releases all resources used by the TraceListener.

(Zděděno od TraceListener)
Dispose(Boolean)

Odstraní tento TextWriterTraceListener objekt.Disposes this TextWriterTraceListener object.

(Zděděno od TextWriterTraceListener)
Equals(Object)

Určí, zda se zadaný objekt rovná aktuálnímu objektu.Determines whether the specified object is equal to the current object.

(Zděděno od Object)
Fail(String)

Vygeneruje chybovou zprávu pro naslouchací proces, který vytvoříte při implementaci TraceListener třídy.Emits an error message to the listener you create when you implement the TraceListener class.

(Zděděno od TraceListener)
Fail(String, String)

Zapíše informace o trasování včetně chybové zprávy a podrobné chybové zprávy do souboru nebo datového proudu.Writes trace information including an error message and a detailed error message to the file or stream.

Flush()

Vyprázdní výstupní vyrovnávací paměť pro Writer .Flushes the output buffer for the Writer.

(Zděděno od TextWriterTraceListener)
GetHashCode()

Slouží jako výchozí funkce hash.Serves as the default hash function.

(Zděděno od Object)
GetLifetimeService()
Zastaralé.

Načte aktuální objekt služby životnosti, který řídí zásady životního cyklu pro tuto instanci.Retrieves the current lifetime service object that controls the lifetime policy for this instance.

(Zděděno od MarshalByRefObject)
GetSupportedAttributes()

Získá vlastní atributy, které podporuje naslouchací proces trasování.Gets the custom attributes supported by the trace listener.

(Zděděno od TraceListener)
GetType()

Získá Type aktuální instanci.Gets the Type of the current instance.

(Zděděno od Object)
InitializeLifetimeService()
Zastaralé.

Získá objekt služby životnosti, který řídí zásady životního cyklu pro tuto instanci.Obtains a lifetime service object to control the lifetime policy for this instance.

(Zděděno od MarshalByRefObject)
MemberwiseClone()

Vytvoří kopii aktuálního seznamu Object .Creates a shallow copy of the current Object.

(Zděděno od Object)
MemberwiseClone(Boolean)

Vytvoří kopii aktuálního objektu bez podstruktury MarshalByRefObject .Creates a shallow copy of the current MarshalByRefObject object.

(Zděděno od MarshalByRefObject)
ToString()

Vrátí řetězec, který představuje aktuální objekt.Returns a string that represents the current object.

(Zděděno od Object)
TraceData(TraceEventCache, String, TraceEventType, Int32, Object)

Zapíše informace o trasování, datový objekt a informace o události do souboru nebo datového proudu.Writes trace information, a data object, and event information to the file or stream.

TraceData(TraceEventCache, String, TraceEventType, Int32, Object[])

Zapisuje informace o trasování, datové objekty a informace o událostech do souboru nebo datového proudu.Writes trace information, data objects, and event information to the file or stream.

TraceEvent(TraceEventCache, String, TraceEventType, Int32)

Zapisuje informace o trasování a události do výstupu specifického pro naslouchací proces.Writes trace and event information to the listener specific output.

(Zděděno od TraceListener)
TraceEvent(TraceEventCache, String, TraceEventType, Int32, String)

Zapisuje informace o trasování, zprávu a událost do souboru nebo datového proudu.Writes trace information, a message, and event information to the file or stream.

TraceEvent(TraceEventCache, String, TraceEventType, Int32, String, Object[])

Zapisuje informace o trasování, formátovanou zprávu a informace o události do souboru nebo datového proudu.Writes trace information, a formatted message, and event information to the file or stream.

TraceTransfer(TraceEventCache, String, Int32, String, Guid)

Zapisuje trasovací informace, včetně identity související aktivity, zprávy a informací o událostech do souboru nebo datového proudu.Writes trace information including the identity of a related activity, a message, and event information to the file or stream.

Write(Object)

Zapíše hodnotu ToString() metody objektu pro naslouchací proces, který vytvoříte při implementaci TraceListener třídy.Writes the value of the object's ToString() method to the listener you create when you implement the TraceListener class.

(Zděděno od TraceListener)
Write(Object, String)

Zapíše název kategorie a hodnotu ToString() metody objektu pro naslouchací proces, který vytvoříte při implementaci TraceListener třídy.Writes a category name and the value of the object's ToString() method to the listener you create when you implement the TraceListener class.

(Zděděno od TraceListener)
Write(String)

Zapíše doslovné zprávy bez dalších informací o kontextu souboru nebo datového proudu.Writes a verbatim message without any additional context information to the file or stream.

Write(String, String)

Zapíše název kategorie a zprávu do naslouchacího procesu, který vytvoříte při implementaci TraceListener třídy.Writes a category name and a message to the listener you create when you implement the TraceListener class.

(Zděděno od TraceListener)
WriteIndent()

Zapíše odsazení do naslouchacího procesu, který vytvoříte při implementaci této třídy, a obnoví NeedIndent vlastnost na false .Writes the indent to the listener you create when you implement this class, and resets the NeedIndent property to false.

(Zděděno od TraceListener)
WriteLine(Object)

Zapíše hodnotu ToString() metody objektu pro naslouchací proces, který vytvoříte při implementaci TraceListener třídy následovaný ukončovacím znakem řádku.Writes the value of the object's ToString() method to the listener you create when you implement the TraceListener class, followed by a line terminator.

(Zděděno od TraceListener)
WriteLine(Object, String)

Zapíše název kategorie a hodnotu ToString() metody objektu pro naslouchací proces, který vytvoříte při implementaci TraceListener třídy následovaný ukončovacím znakem řádku.Writes a category name and the value of the object's ToString() method to the listener you create when you implement the TraceListener class, followed by a line terminator.

(Zděděno od TraceListener)
WriteLine(String)

Zapíše doslovné zprávu bez jakýchkoli dalších kontextových informací následovaných ukončovacím znakem aktuálního řádku do souboru nebo datového proudu.Writes a verbatim message without any additional context information followed by the current line terminator to the file or stream.

WriteLine(String, String)

Zapíše název kategorie a zprávu do naslouchacího procesu, který vytvoříte při implementaci TraceListener třídy následovaný ukončovacím znakem řádku.Writes a category name and a message to the listener you create when you implement the TraceListener class, followed by a line terminator.

(Zděděno od TraceListener)

Platí pro