Поделиться через


TextWriterTraceListener Класс

Определение

Направляет вывод отладки или трассировки в 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
Наследование
TextWriterTraceListener
Наследование
TextWriterTraceListener
Производный

Примеры

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

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

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

Важно!

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

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

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

  • Чтобы включить отладку /d:DEBUG в C#, добавьте флаг в командную строку компилятора при компиляции кода или в #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)

Инициализирует новый экземпляр класса TextWriterTraceListener, используя этот поток в качестве получателя выходных данных отладки и трассировки.

TextWriterTraceListener(Stream, String)

Инициализирует новый экземпляр класса TextWriterTraceListener с заданным именем, используя этот поток в качестве получателя выходных данных отладки и трассировки.

TextWriterTraceListener(String)

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

TextWriterTraceListener(String, String)

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

TextWriterTraceListener(TextWriter)

Инициализирует новый экземпляр класса TextWriterTraceListener, используя заданное средство записи в качестве получателя выходных данных отладки или трассировки.

TextWriterTraceListener(TextWriter, String)

Инициализирует новый экземпляр класса TextWriterTraceListener с заданным именем, используя заданное средство записи в качестве получателя выходных данных отладки или трассировки.

Свойства

Attributes

Возвращает настраиваемые атрибуты прослушивателя трассировки, определенные в файле конфигурации приложения.

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

Получает или задает фильтр трассировки для прослушивателя трассировки.

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

Возвращает или задает уровень отступа.

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

Возвращает или задает число пробелов в отступе.

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

Возвращает значение, указывающее, является ли прослушиватель трассировки потокобезопасным.

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

Возвращает или задает имя для данного TraceListener.

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

Возвращает или задает значение, указывающее, нужен ли отступ в выходных данных.

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

Возвращает или задает параметры выходных данных трассировки.

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

Возвращает или задает средство записи текста, принимающее выходные данные трассировки или отладки.

Методы

Close()

Закрывает свойство Writer, которое, таким образом, больше не получает выходные данные отладки или трассировки.

Close()

Если переопределено в производном классе, закрывает выходной поток, который, таким образом, больше не принимает выходные данные трассировки и отладки.

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

Создает объект, который содержит всю необходимую информацию для создания прокси-сервера, используемого для взаимодействия с удаленным объектом.

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

Освобождает все ресурсы, занятые модулем TraceListener.

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

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

Equals(Object)

Определяет, равен ли указанный объект текущему объекту.

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

Посылает сообщение об ошибке в прослушиватель, создаваемый при реализации класса TraceListener.

(Унаследовано от TraceListener)
Fail(String, 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)

Записывает сведения трассировки и сведения о событиях в специальные выходные данные прослушивателя.

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

Записывает сведения трассировки, сообщение и сведения о событиях в специальные выходные данные прослушивателя.

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

Записывает сведения трассировки, форматированный массив объектов данных и сведения о событиях в специальные выходные данные прослушивателя.

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

Записывает сведения трассировки, сообщение, идентификатор сопутствующего действия и сведения о событиях в специальные выходные данные прослушивателя.

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

Записывает значение метода ToString() объекта в прослушиватель, создаваемый при реализации класса TraceListener.

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

Записывает имя категории и значение метода ToString() объекта в прослушиватель, создаваемый при реализации класса TraceListener.

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

Записывает сообщение в свойство Writer данного экземпляра.

Write(String, String)

Записывает имя категории и сообщение в прослушиватель, создаваемый при реализации класса TraceListener.

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

Записывает отступ в прослушиватель, создаваемый при реализации этого класса, и восстанавливает для свойства NeedIndent значение false.

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

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

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

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

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

Записывает сообщение в свойство Writer данного экземпляра, за которым следует ограничитель строки. Ограничитель строки по умолчанию — возврат каретки, за которым следует перевод строки (\r\n).

WriteLine(String, String)

Записывает имя категории и сообщение, заканчивающееся знаком завершения строки, в прослушиватель, создаваемый при реализации класса TraceListener.

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

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

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