TextWriterTraceListener Класс

Определение

Пространство имен:

System.Diagnostics

Сборки:

netstandard.dll, System.Diagnostics.TextWriterTraceListener.dll

Исходный код:

TextWriterTraceListener.cs

Направляет выходные данные трассировки или отладки в объект или TextWriter в объект Stream, например FileStream.

public ref class TextWriterTraceListener : System::Diagnostics::TraceListener

public class TextWriterTraceListener : System.Diagnostics.TraceListener

type TextWriterTraceListener = class
    inherit TraceListener

Public Class TextWriterTraceListener
Inherits TraceListener

Наследование

Object

MarshalByRefObject

TraceListener

TextWriterTraceListener

Производный

System.Diagnostics.ConsoleTraceListener

System.Diagnostics.DelimitedListTraceListener

System.Diagnostics.EventSchemaTraceListener

System.Diagnostics.XmlWriterTraceListener

Примеры

В следующем примере реализуется экземпляр TextWriterTraceListener класса, который использует StreamWriter вызов myOutputWriter для записи в файл с именем TestFile.txt. Сначала в примере создается файл для выходных данных. Затем он создает StreamWriter первый текстовый модуль записи, назначает его выходной файл и добавляет его в .Listeners Затем код выводит одну строку текста в файл. Наконец, в примере выполняется очистка выходного буфера.

После выполнения этого примера можно открыть TestFile.txt файл, чтобы просмотреть выходные данные.

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

Это важно

Этот тип реализует IDisposable интерфейс. Завершив использование типа, следует избавиться от него напрямую или косвенно. Чтобы удалить тип напрямую, вызовите его Dispose метод в блоке try/catch . Чтобы удалить его косвенно, используйте конструкцию языка, например using (в C#) или Using (в Visual Basic). Дополнительные сведения см. в разделе "Использование объекта, реализующего IDisposable" в IDisposable разделе интерфейса.

Этот класс также предоставляет методы CloseWriter таким образом, чтобы он больше не получал выходные данные трассировки или отладки, Flush в выходной буфер для объекта Writerи сообщенияWrite.Writer

Необходимо включить трассировку или отладку для использования прослушивателя трассировки. Следующий синтаксис является определенным компилятором. Если вы используете компиляторы, отличные от C# или Visual Basic, обратитесь к документации для компилятора.

• Чтобы включить отладку в C#, добавьте /d:DEBUG флаг в командную строку компилятора при компиляции кода или добавьте #define DEBUG в начало файла. В Visual Basic добавьте /d:DEBUG=True флаг в командную строку компилятора.

• Чтобы включить трассировку в C#, добавьте /d:TRACE флаг в командную строку компилятора при компиляции кода или добавьте #define TRACE в начало файла. В Visual Basic добавьте /d:TRACE=True флаг в командную строку компилятора.

Чтобы добавить прослушиватель трассировки в приложение .NET Framework, измените файл конфигурации, соответствующий имени приложения. В этом файле можно добавить прослушиватель, задать тип и задать его параметр, удалить прослушиватель или очистить все прослушиватели, заданные приложением ранее. Файл конфигурации должен быть отформатирован, как показано в следующем примере.

<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.

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

Имя	Описание
TextWriterTraceListener()	Инициализирует новый экземпляр TextWriterTraceListener класса в TextWriter качестве выходного получателя.
TextWriterTraceListener(Stream, String)	Инициализирует новый экземпляр TextWriterTraceListener класса с указанным именем, используя поток в качестве получателя выходных данных отладки и трассировки.
TextWriterTraceListener(Stream)	Инициализирует новый экземпляр TextWriterTraceListener класса, используя поток в качестве получателя выходных данных отладки и трассировки.
TextWriterTraceListener(String, String)	Инициализирует новый экземпляр TextWriterTraceListener класса с указанным именем, используя файл в качестве получателя выходных данных отладки и трассировки.
TextWriterTraceListener(String)	Инициализирует новый экземпляр TextWriterTraceListener класса, используя файл в качестве получателя выходных данных отладки и трассировки.
TextWriterTraceListener(TextWriter, String)	Инициализирует новый экземпляр TextWriterTraceListener класса с указанным именем, используя указанный модуль записи в качестве получателя выходных данных трассировки или отладки.
TextWriterTraceListener(TextWriter)	Инициализирует новый экземпляр TextWriterTraceListener класса, используя указанный модуль записи в качестве получателя выходных данных трассировки или отладки.

Свойства

Имя	Описание
Attributes	Возвращает атрибуты пользовательского прослушивателя трассировки, определенные в файле конфигурации приложения. (Унаследовано от TraceListener)
Filter	Возвращает или задает фильтр трассировки для прослушивателя трассировки. (Унаследовано от TraceListener)
IndentLevel	Возвращает или задает уровень отступа. (Унаследовано от TraceListener)
IndentSize	Возвращает или задает количество пробелов в отступе. (Унаследовано от TraceListener)
IsThreadSafe	Возвращает значение, указывающее, является ли прослушиватель трассировки потокобезопасной. (Унаследовано от TraceListener)
Name	Возвращает или задает имя для этого TraceListener. (Унаследовано от TraceListener)
NeedIndent	Возвращает или задает значение, указывающее, следует ли отступить выходные данные. (Унаследовано от TraceListener)
TraceOutputOptions	Возвращает или задает параметры выходных данных трассировки. (Унаследовано от TraceListener)
Writer	Возвращает или задает средство записи текста, получающее выходные данные трассировки или отладки.

Методы

Имя	Описание
Close()	Закрывает таким Writer образом, чтобы он больше не получал выходные данные трассировки или отладки.
Dispose()	Освобождает все ресурсы, используемые параметром TraceListener. (Унаследовано от TraceListener)
Dispose(Boolean)	Удаляет этот TextWriterTraceListener объект.
Equals(Object)	Определяет, равен ли указанный объект текущему объекту. (Унаследовано от Object)
Fail(String, String)	Выдает сообщение об ошибке и подробное сообщение об ошибке прослушивателю, создаваемому TraceListener при реализации класса. (Унаследовано от TraceListener)
Fail(String)	Выдает сообщение об ошибке прослушивателю, создаваемому при реализации TraceListener класса. (Унаследовано от TraceListener)
Flush()	Очищает выходной буфер для Writer.
GetHashCode()	Служит хэш-функцией по умолчанию. (Унаследовано от Object)
GetLifetimeService()	Устаревшие.. Извлекает текущий объект службы времени существования, который управляет политикой времени существования для этого экземпляра. (Унаследовано от MarshalByRefObject)
GetSupportedAttributes()	Возвращает настраиваемые атрибуты, поддерживаемые прослушивателем трассировки. (Унаследовано от TraceListener)
GetType()	Возвращает Type текущего экземпляра. (Унаследовано от Object)
InitializeLifetimeService()	Устаревшие.. Получает объект службы времени существования для управления политикой времени существования для этого экземпляра. (Унаследовано от MarshalByRefObject)
MemberwiseClone()	Создает неглубокую копию текущей Object. (Унаследовано от Object)
MemberwiseClone(Boolean)	Создает неглубокую копию текущего MarshalByRefObject объекта. (Унаследовано от MarshalByRefObject)
ToString()	Возвращает строку, представляющую текущий объект. (Унаследовано от Object)
TraceData(TraceEventCache, String, TraceEventType, Int32, Object)	Записывает сведения трассировки, объект данных и сведения о событии в конкретный выход прослушивателя. (Унаследовано от TraceListener)
TraceData(TraceEventCache, String, TraceEventType, Int32, Object[])	Записывает сведения трассировки, массив объектов данных и сведений о событиях в конкретный выходной объект прослушивателя. (Унаследовано от TraceListener)
TraceEvent(TraceEventCache, String, TraceEventType, Int32, String, Object[])	Записывает сведения трассировки, форматированный массив объектов и сведений о событиях в конкретный выходной объект прослушивателя. (Унаследовано от TraceListener)
TraceEvent(TraceEventCache, String, TraceEventType, Int32, String)	Записывает сведения трассировки, сообщение и сведения о событии в конкретный выход прослушивателя. (Унаследовано от TraceListener)
TraceEvent(TraceEventCache, String, TraceEventType, Int32)	Записывает данные трассировки и события в конкретный выход прослушивателя. (Унаследовано от TraceListener)
TraceTransfer(TraceEventCache, String, Int32, String, Guid)	Записывает сведения трассировки, сообщение, связанное удостоверение действия и сведения о событиях прослушивателя в определенные выходные данные прослушивателя. (Унаследовано от TraceListener)
Write(Object, String)	Записывает имя категории и значение метода объекта ToString() в прослушиватель, который вы создаете при реализации TraceListener класса. (Унаследовано от TraceListener)
Write(Object)	Записывает значение метода объекта ToString() в прослушиватель, который вы создаете при реализации TraceListener класса. (Унаследовано от TraceListener)
Write(String, String)	Записывает имя категории и сообщение прослушивателя, создаваемого TraceListener при реализации класса. (Унаследовано от TraceListener)
Write(String)	Записывает сообщение в этот экземпляр Writer.
WriteIndent()	Записывает отступ в прослушиватель, который вы создаете при реализации этого класса, и сбрасывает свойство falseв NeedIndent . (Унаследовано от TraceListener)
WriteLine(Object, String)	Записывает имя категории и значение метода объекта ToString() в прослушиватель, который вы создаете при реализации TraceListener класса, за которым следует терминатор строки. (Унаследовано от TraceListener)
WriteLine(Object)	Записывает значение метода объекта ToString() в прослушиватель, который создается при реализации TraceListener класса, за которым следует терминатор строки. (Унаследовано от TraceListener)
WriteLine(String, String)	Записывает имя категории и сообщение прослушивателю, созданному при реализации TraceListener класса, за которым следует терминатор строки. (Унаследовано от TraceListener)
WriteLine(String)	Записывает сообщение в экземпляр Writer , за которым следует терминатор строки. Терминатор строки по умолчанию — это возврат каретки, за которой следует канал строки (\r\n).

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

• TraceListener
• DefaultTraceListener
• ConsoleTraceListener
• EventLogTraceListener
• Stream
• TextWriter
• Debug
• Trace