TextWriterTraceListener 类

定义

命名空间:

System.Diagnostics

程序集:

System.Diagnostics.TextWriterTraceListener.dll

Source:

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 文件以查看输出。

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 接口。 在使用完类型后，您应直接或间接释放类型。 若要直接释放类型，请在 try/catch 块中调用其 Dispose 方法。 若要间接释放类型，请使用 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()	用 TextWriter 作为输出接收者来初始化 TextWriterTraceListener 类的新实例。
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，以使其不再接收跟踪或调试输出。
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)	实现 TraceListener 类时，向所创建的侦听器写入对象的 ToString() 方法值，后跟行结束符。 (继承自 TraceListener)
WriteLine(Object, String)	实现 TraceListener 类时，向所创建的侦听器写入类别名称和对象的 ToString() 方法值，后跟行结束符。 (继承自 TraceListener)
WriteLine(String)	将一条消息写入该实例的 Writer，后跟行结束符。 默认行结束符是回车符后接一个换行符 (\r\n)。
WriteLine(String, String)	实现 TraceListener 类时，向所创建的侦听器写入类别名称和消息，后跟行结束符。 (继承自 TraceListener)

另请参阅

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