TextWriterTraceListener Класс

Определение

Направляет вывод отладки или трассировки в TextWriter или в Stream, например, FileStream.Directs tracing or debugging output to a TextWriter or to a Stream, such as FileStream.

public ref class TextWriterTraceListener : System::Diagnostics::TraceListener
public class TextWriterTraceListener : System.Diagnostics.TraceListener
type TextWriterTraceListener = class
    inherit TraceListener
Public Class TextWriterTraceListener
Inherits TraceListener
Наследование
TextWriterTraceListener
Наследование
TextWriterTraceListener
Производный

Примеры

В следующем примере реализуется экземпляр TextWriterTraceListener класса, который использует метод, StreamWriter вызываемый myOutputWriter для записи в файл с именем TestFile.txt .The following example implements an instance of the TextWriterTraceListener class that uses a StreamWriter called myOutputWriter to write to a file named TestFile.txt. Сначала в примере создается файл для вывода.First the example creates a file for output. Затем он создает StreamWriter для первого модуля записи текста, присваивает ему выходной файл и добавляет его в Listeners .Then it creates the StreamWriter for the first text writer, assigns it the output file, and adds it to the Listeners. Затем код выводит одну строку текста в файл.Then, the code outputs one line of text to the file. Наконец, в примере очищается выходной буфер.Finally, the example flushes the output buffer.

После выполнения этого примера можно открыть TestFile.txt файл, чтобы увидеть выходные данные.After running this sample, you can open the TestFile.txt file to see the output.

void main()
{
   #if defined(TRACE)
   // Create a file for output named TestFile.txt.
   Stream^ myFile = File::Create( "TestFile.txt" );
   
   // Create a new text writer using the output stream and
   // add it to the trace listeners.
   TextWriterTraceListener^ myTextListener = 
      gcnew TextWriterTraceListener( myFile );
   Trace::Listeners->Add( myTextListener );
  
   // Write output to the file.
   Trace::Write( "Test output " );
  
   // Flush the output.
   Trace::Flush();
   Trace::Close();
   #endif
}
public class Sample
{

public static int Main(string[] args) {
    // Create a file for output named TestFile.txt.
    Stream myFile = File.Create("TestFile.txt");

    /* Create a new text writer using the output stream, and add it to
     * the trace listeners. */
    TextWriterTraceListener myTextListener = new
       TextWriterTraceListener(myFile);
    Trace.Listeners.Add(myTextListener);

    // Write output to the file.
    Trace.Write("Test output ");

    // Flush the output.
    Trace.Flush();

    return 0;
 }
}
Public Class Sample
    
    Public Shared Sub Main()
        ' Create a file for output named TestFile.txt.
        Dim myFile As Stream = File.Create("TestFile.txt")
        
        ' Create a new text writer using the output stream, and add it to
        ' the trace listeners. 
        Dim myTextListener As New TextWriterTraceListener(myFile)
        Trace.Listeners.Add(myTextListener)

        
        ' Write output to the file.
        Trace.Write("Test output ")
        
        ' Flush the output.
        Trace.Flush() 

        System.Environment.ExitCode = 0
    End Sub

End Class

Комментарии

TextWriterTraceListenerКласс предоставляет Writer свойство для получения или задания модуля записи текста, который получает выходные данные трассировки или отладки.The TextWriterTraceListener class provides the Writer property to get or set the text writer that receives the tracing or debugging output.

Важно!

Этот тип реализует интерфейс IDisposable.This type implements the IDisposable interface. По окончании использования выдаленную ему память следует прямо или косвенно освободить.When you have finished using the type, you should dispose of it either directly or indirectly. Чтобы сделать это прямо, вызовите его метод Dispose в блоке try/catch.To dispose of the type directly, call its Dispose method in a try/catch block. Чтобы сделать это косвенно, используйте языковые конструкции, такие как using (в C#) или Using (в Visual Basic).To dispose of it indirectly, use a language construct such as using (in C#) or Using (in Visual Basic). Дополнительные сведения см. в разделе "Использование объекта, реализующего IDisposable" в статье об интерфейсе IDisposable.For more information, see the "Using an Object that Implements IDisposable" section in the IDisposable interface topic.

Этот класс также предоставляет методы для Close , Writer чтобы он больше не получал выходные данные трассировки или отладки, в Flush выходной буфер для Writer , а также в Write сообщение Writer .This class also provides methods to Close the Writer so that it no longer receives tracing or debugging output, to Flush the output buffer for the Writer, and to Write a message to the Writer.

Для использования прослушивателя трассировки необходимо включить трассировку или отладку.You must enable tracing or debugging to use a trace listener. Ниже приведен синтаксис, характерный для компилятора.The following syntax is compiler specific. Если используются компиляторы, отличные от C# или Visual Basic, обратитесь к документации по компилятору.If you use compilers other than C# or Visual Basic, refer to the documentation for your compiler.

  • Чтобы включить отладку в C#, добавьте /d:DEBUG флаг в командную строку компилятора при компиляции кода или добавьте #define DEBUG в начало файла.To enable debugging in C#, add the /d:DEBUG flag to the compiler command line when you compile your code, or you can add #define DEBUG to the top of your file. В Visual Basic добавьте /d:DEBUG=True флаг в командную строку компилятора.In Visual Basic, add the /d:DEBUG=True flag to the compiler command line.

  • Чтобы включить трассировку в C#, добавьте /d:TRACE флаг в командную строку компилятора при компиляции кода или добавьте #define TRACE в начало файла.To enable tracing in C#, add the /d:TRACE flag to the compiler command line when you compile your code, or add #define TRACE to the top of your file. В Visual Basic добавьте /d:TRACE=True флаг в командную строку компилятора.In Visual Basic, add the /d:TRACE=True flag to the compiler command line.

Чтобы добавить прослушиватель трассировки, измените файл конфигурации, соответствующий имени приложения.To add a trace listener, edit the configuration file that corresponds to the name of your application. В этом файле можно добавить прослушиватель, задать его тип и задать его параметр, удалить прослушиватель или удалить все прослушиватели, заданные приложением ранее.Within this file, you can add a listener, set its type and set its parameter, remove a listener, or clear all the listeners previously set by the application. Файл конфигурации следует отформатировать, как показано в следующем примере.The configuration file should be formatted like the following example.

<configuration>  
  <system.diagnostics>  
    <trace autoflush="false" indentsize="4">  
      <listeners>  
        <add name="myListener"   
          type="System.Diagnostics.TextWriterTraceListener"   
          initializeData="TextWriterOutput.log" />  
        <remove name="Default" />  
      </listeners>  
    </trace>  
  </system.diagnostics>  
</configuration>  

Примечание

При попытке записи в файл, который используется или недоступен, имя файла автоматически предваряется идентификатором 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.

Конструкторы

TextWriterTraceListener()

Инициализирует новый экземпляр класса TextWriterTraceListener с помощью TextWriter в качестве выходного получателя.Initializes a new instance of the TextWriterTraceListener class with TextWriter as the output recipient.

TextWriterTraceListener(Stream)

Инициализирует новый экземпляр класса TextWriterTraceListener, используя этот поток в качестве получателя выходных данных отладки и трассировки.Initializes a new instance of the TextWriterTraceListener class, using the stream as the recipient of the debugging and tracing output.

TextWriterTraceListener(Stream, String)

Инициализирует новый экземпляр класса TextWriterTraceListener с заданным именем, используя этот поток в качестве получателя выходных данных отладки и трассировки.Initializes a new instance of the TextWriterTraceListener class with the specified name, using the stream as the recipient of the debugging and tracing output.

TextWriterTraceListener(String)

Инициализирует новый экземпляр класса TextWriterTraceListener, используя этот файл в качестве получателя выходных данных отладки и трассировки.Initializes a new instance of the TextWriterTraceListener class, using the file as the recipient of the debugging and tracing output.

TextWriterTraceListener(String, String)

Инициализирует новый экземпляр класса TextWriterTraceListener с заданным именем, используя этот файл в качестве получателя выходных данных отладки и трассировки.Initializes a new instance of the TextWriterTraceListener class with the specified name, using the file as the recipient of the debugging and tracing output.

TextWriterTraceListener(TextWriter)

Инициализирует новый экземпляр класса TextWriterTraceListener, используя заданное средство записи в качестве получателя выходных данных отладки или трассировки.Initializes a new instance of the TextWriterTraceListener class using the specified writer as recipient of the tracing or debugging output.

TextWriterTraceListener(TextWriter, String)

Инициализирует новый экземпляр класса TextWriterTraceListener с заданным именем, используя заданное средство записи в качестве получателя выходных данных отладки или трассировки.Initializes a new instance of the TextWriterTraceListener class with the specified name, using the specified writer as recipient of the tracing or debugging output.

Свойства

Attributes

Возвращает настраиваемые атрибуты прослушивателя трассировки, определенные в файле конфигурации приложения.Gets the custom trace listener attributes defined in the application configuration file.

(Унаследовано от TraceListener)
Filter

Получает или задает фильтр трассировки для прослушивателя трассировки.Gets or sets the trace filter for the trace listener.

(Унаследовано от TraceListener)
IndentLevel

Возвращает или задает уровень отступа.Gets or sets the indent level.

(Унаследовано от TraceListener)
IndentSize

Возвращает или задает число пробелов в отступе.Gets or sets the number of spaces in an indent.

(Унаследовано от TraceListener)
IsThreadSafe

Возвращает значение, указывающее, является ли прослушиватель трассировки потокобезопасным.Gets a value indicating whether the trace listener is thread safe.

(Унаследовано от TraceListener)
Name

Возвращает или задает имя для данного TraceListener.Gets or sets a name for this TraceListener.

(Унаследовано от TraceListener)
NeedIndent

Возвращает или задает значение, указывающее, нужен ли отступ в выходных данных.Gets or sets a value indicating whether to indent the output.

(Унаследовано от TraceListener)
TraceOutputOptions

Возвращает или задает параметры выходных данных трассировки.Gets or sets the trace output options.

(Унаследовано от TraceListener)
Writer

Возвращает или задает средство записи текста, принимающее выходные данные трассировки или отладки.Gets or sets the text writer that receives the tracing or debugging output.

Методы

Close()

Закрывает свойство Writer, которое, таким образом, больше не получает выходные данные отладки или трассировки.Closes the Writer so that it no longer receives tracing or debugging output.

Close()

Если переопределено в производном классе, закрывает выходной поток, который, таким образом, больше не принимает выходные данные трассировки и отладки.When overridden in a derived class, closes the output stream so it no longer receives tracing or debugging output.

(Унаследовано от TraceListener)
CreateObjRef(Type)

Создает объект, который содержит всю необходимую информацию для создания прокси-сервера, используемого для взаимодействия с удаленным объектом.Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.

(Унаследовано от MarshalByRefObject)
Dispose()

Освобождает все ресурсы, занятые модулем TraceListener.Releases all resources used by the TraceListener.

(Унаследовано от TraceListener)
Dispose(Boolean)

Удаляет этот объект TextWriterTraceListener.Disposes this TextWriterTraceListener object.

Equals(Object)

Определяет, равен ли указанный объект текущему объекту.Determines whether the specified object is equal to the current object.

(Унаследовано от Object)
Fail(String)

Посылает сообщение об ошибке в прослушиватель, создаваемый при реализации класса TraceListener.Emits an error message to the listener you create when you implement the TraceListener class.

(Унаследовано от TraceListener)
Fail(String, String)

Выдает простое и подробное сообщение об ошибке в прослушиватель, создаваемый при реализации класса TraceListener.Emits an error message and a detailed error message to the listener you create when you implement the TraceListener class.

(Унаследовано от TraceListener)
Flush()

Очищает выходной буфер для свойства Writer.Flushes the output buffer for the Writer.

GetHashCode()

Служит хэш-функцией по умолчанию.Serves as the default hash function.

(Унаследовано от Object)
GetLifetimeService()

Извлекает объект обслуживания во время существования, который управляет политикой времени существования данного экземпляра.Retrieves the current lifetime service object that controls the lifetime policy for this instance.

(Унаследовано от MarshalByRefObject)
GetSupportedAttributes()

Возвращает настраиваемые атрибуты, поддерживаемые прослушивателем трассировки.Gets the custom attributes supported by the trace listener.

(Унаследовано от TraceListener)
GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Унаследовано от Object)
InitializeLifetimeService()

Получает объект службы времени существования для управления политикой времени существования для этого экземпляра.Obtains a lifetime service object to control the lifetime policy for this instance.

(Унаследовано от MarshalByRefObject)
MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Унаследовано от Object)
MemberwiseClone(Boolean)

Создает неполную копию текущего объекта MarshalByRefObject.Creates a shallow copy of the current MarshalByRefObject object.

(Унаследовано от MarshalByRefObject)
ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Унаследовано от Object)
TraceData(TraceEventCache, String, TraceEventType, Int32, Object)

Записывает сведения трассировки, объект данных и сведения о событиях в специальные выходные данные прослушивателя.Writes trace information, a data object and event information to the listener specific output.

(Унаследовано от TraceListener)
TraceData(TraceEventCache, String, TraceEventType, Int32, Object[])

Записывает сведения трассировки, массив объектов данных и сведения о событии в специальные выходные данные прослушивателя.Writes trace information, an array of data objects and event information to the listener specific output.

(Унаследовано от TraceListener)
TraceEvent(TraceEventCache, String, TraceEventType, Int32)

Записывает сведения трассировки и сведения о событиях в специальные выходные данные прослушивателя.Writes trace and event information to the listener specific output.

(Унаследовано от TraceListener)
TraceEvent(TraceEventCache, String, TraceEventType, Int32, String)

Записывает сведения трассировки, сообщение и сведения о событиях в специальные выходные данные прослушивателя.Writes trace information, a message, and event information to the listener specific output.

(Унаследовано от TraceListener)
TraceEvent(TraceEventCache, String, TraceEventType, Int32, String, Object[])

Записывает сведения трассировки, форматированный массив объектов данных и сведения о событиях в специальные выходные данные прослушивателя.Writes trace information, a formatted array of objects and event information to the listener specific output.

(Унаследовано от TraceListener)
TraceTransfer(TraceEventCache, String, Int32, String, Guid)

Записывает сведения трассировки, сообщение, идентификатор сопутствующего действия и сведения о событиях в специальные выходные данные прослушивателя.Writes trace information, a message, a related activity identity and event information to the listener specific output.

(Унаследовано от TraceListener)
Write(Object)

Записывает значение метода ToString() объекта в прослушиватель, создаваемый при реализации класса TraceListener.Writes the value of the object's ToString() method to the listener you create when you implement the TraceListener class.

(Унаследовано от TraceListener)
Write(Object, String)

Записывает имя категории и значение метода ToString() объекта в прослушиватель, создаваемый при реализации класса TraceListener.Writes a category name and the value of the object's ToString() method to the listener you create when you implement the TraceListener class.

(Унаследовано от TraceListener)
Write(String)

Записывает сообщение в свойство Writer данного экземпляра.Writes a message to this instance's Writer.

Write(String, String)

Записывает имя категории и сообщение в прослушиватель, создаваемый при реализации класса TraceListener.Writes a category name and a message to the listener you create when you implement the TraceListener class.

(Унаследовано от TraceListener)
WriteIndent()

Записывает отступ в прослушиватель, создаваемый при реализации этого класса, и восстанавливает для свойства NeedIndent значение false.Writes the indent to the listener you create when you implement this class, and resets the NeedIndent property to false.

(Унаследовано от TraceListener)
WriteLine(Object)

Записывает значение метода ToString() объекта, заканчивающееся знаком завершения строки, в прослушиватель, создаваемый при реализации класса TraceListener.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.

(Унаследовано от TraceListener)
WriteLine(Object, String)

Записывает имя категории и значение метода ToString() объекта, заканчивающееся знаком завершения строки, в прослушиватель, создаваемый при реализации класса TraceListener.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.

(Унаследовано от TraceListener)
WriteLine(String)

Записывает сообщение в свойство Writer данного экземпляра, за которым следует ограничитель строки.Writes a message to this instance's Writer followed by a line terminator. Ограничитель строки по умолчанию — возврат каретки, за которым следует перевод строки (\r\n).The default line terminator is a carriage return followed by a line feed (\r\n).

WriteLine(String, String)

Записывает имя категории и сообщение, заканчивающееся знаком завершения строки, в прослушиватель, создаваемый при реализации класса TraceListener.Writes a category name and a message to the listener you create when you implement the TraceListener class, followed by a line terminator.

(Унаследовано от TraceListener)

Применяется к

См. также раздел