1 <?xml version="1.0" encoding="utf-8"?>
4 <name>System.Diagnostics.TextWriterTraceListener</name>
7 <member name="T:System.Diagnostics.ConsoleTraceListener">
8 <summary>Directs tracing or debugging output to either the standard output or the standard error stream.</summary>
10 <member name="M:System.Diagnostics.ConsoleTraceListener.#ctor">
11 <summary>Initializes a new instance of the <see cref="T:System.Diagnostics.ConsoleTraceListener" /> class with trace output written to the standard output stream.</summary>
13 <member name="M:System.Diagnostics.ConsoleTraceListener.#ctor(System.Boolean)">
14 <summary>Initializes a new instance of the <see cref="T:System.Diagnostics.ConsoleTraceListener" /> class with an option to write trace output to the standard output stream or the standard error stream.</summary>
15 <param name="useErrorStream">
16 <see langword="true" /> to write tracing and debugging output to the standard error stream; <see langword="false" /> to write tracing and debugging output to the standard output stream.</param>
18 <member name="M:System.Diagnostics.ConsoleTraceListener.Close">
19 <summary>Closes the output to the stream specified for this trace listener.</summary>
21 <member name="T:System.Diagnostics.DelimitedListTraceListener">
22 <summary>Directs tracing or debugging output to a text writer, such as a stream writer, or to a stream, such as a file stream.</summary>
24 <member name="M:System.Diagnostics.DelimitedListTraceListener.#ctor(System.IO.Stream)">
25 <summary>Initializes a new instance of the <see cref="T:System.Diagnostics.DelimitedListTraceListener" /> class that writes to the specified output stream.</summary>
26 <param name="stream">The <see cref="T:System.IO.Stream" /> to receive the output.</param>
27 <exception cref="T:System.ArgumentNullException">
28 <paramref name="stream" /> is <see langword="null" />.</exception>
30 <member name="M:System.Diagnostics.DelimitedListTraceListener.#ctor(System.IO.Stream,System.String)">
31 <summary>Initializes a new instance of the <see cref="T:System.Diagnostics.DelimitedListTraceListener" /> class that writes to the specified output stream and has the specified name.</summary>
32 <param name="stream">The <see cref="T:System.IO.Stream" /> to receive the output.</param>
33 <param name="name">The name of the new instance of the trace listener.</param>
34 <exception cref="T:System.ArgumentNullException">
35 <paramref name="stream" /> is <see langword="null" />.</exception>
37 <member name="M:System.Diagnostics.DelimitedListTraceListener.#ctor(System.IO.TextWriter)">
38 <summary>Initializes a new instance of the <see cref="T:System.Diagnostics.DelimitedListTraceListener" /> class that writes to the specified text writer.</summary>
39 <param name="writer">The <see cref="T:System.IO.TextWriter" /> to receive the output.</param>
40 <exception cref="T:System.ArgumentNullException">
41 <paramref name="writer" /> is <see langword="null" />.</exception>
43 <member name="M:System.Diagnostics.DelimitedListTraceListener.#ctor(System.IO.TextWriter,System.String)">
44 <summary>Initializes a new instance of the <see cref="T:System.Diagnostics.DelimitedListTraceListener" /> class that writes to the specified text writer and has the specified name.</summary>
45 <param name="writer">The <see cref="T:System.IO.TextWriter" /> to receive the output.</param>
46 <param name="name">The name of the new instance of the trace listener.</param>
47 <exception cref="T:System.ArgumentNullException">
48 <paramref name="writer" /> is <see langword="null" />.</exception>
50 <member name="M:System.Diagnostics.DelimitedListTraceListener.#ctor(System.String)">
51 <summary>Initializes a new instance of the <see cref="T:System.Diagnostics.DelimitedListTraceListener" /> class that writes to the specified file.</summary>
52 <param name="fileName">The name of the file to receive the output.</param>
53 <exception cref="T:System.ArgumentNullException">
54 <paramref name="fileName" /> is <see langword="null" />.</exception>
56 <member name="M:System.Diagnostics.DelimitedListTraceListener.#ctor(System.String,System.String)">
57 <summary>Initializes a new instance of the <see cref="T:System.Diagnostics.DelimitedListTraceListener" /> class that writes to the specified file and has the specified name.</summary>
58 <param name="fileName">The name of the file to receive the output.</param>
59 <param name="name">The name of the new instance of the trace listener.</param>
60 <exception cref="T:System.ArgumentNullException">
61 <paramref name="fileName" /> is <see langword="null" />.</exception>
63 <member name="M:System.Diagnostics.DelimitedListTraceListener.GetSupportedAttributes">
64 <summary>Returns the custom configuration file attribute supported by the delimited trace listener.</summary>
65 <returns>A string array that contains the single value "delimiter".</returns>
67 <member name="M:System.Diagnostics.DelimitedListTraceListener.TraceData(System.Diagnostics.TraceEventCache,System.String,System.Diagnostics.TraceEventType,System.Int32,System.Object)">
68 <summary>Writes trace information, a data object, and event information to the output file or stream.</summary>
69 <param name="eventCache">A <see cref="T:System.Diagnostics.TraceEventCache" /> object that contains the current process ID, thread ID, and stack trace information.</param>
70 <param name="source">A name used to identify the output, typically the name of the application that generated the trace event.</param>
71 <param name="eventType">One of the <see cref="T:System.Diagnostics.TraceEventType" /> values specifying the type of event that has caused the trace.</param>
72 <param name="id">A numeric identifier for the event.</param>
73 <param name="data">A data object to write to the output file or stream.</param>
75 <member name="M:System.Diagnostics.DelimitedListTraceListener.TraceData(System.Diagnostics.TraceEventCache,System.String,System.Diagnostics.TraceEventType,System.Int32,System.Object[])">
76 <summary>Writes trace information, an array of data objects, and event information to the output file or stream.</summary>
77 <param name="eventCache">A <see cref="T:System.Diagnostics.TraceEventCache" /> object that contains the current process ID, thread ID, and stack trace information.</param>
78 <param name="source">A name used to identify the output, typically the name of the application that generated the trace event.</param>
79 <param name="eventType">One of the <see cref="T:System.Diagnostics.TraceEventType" /> values specifying the type of event that has caused the trace.</param>
80 <param name="id">A numeric identifier for the event.</param>
81 <param name="data">An array of data objects to write to the output file or stream.</param>
83 <member name="M:System.Diagnostics.DelimitedListTraceListener.TraceEvent(System.Diagnostics.TraceEventCache,System.String,System.Diagnostics.TraceEventType,System.Int32,System.String)">
84 <summary>Writes trace information, a message, and event information to the output file or stream.</summary>
85 <param name="eventCache">A <see cref="T:System.Diagnostics.TraceEventCache" /> object that contains the current process ID, thread ID, and stack trace information.</param>
86 <param name="source">A name used to identify the output, typically the name of the application that generated the trace event.</param>
87 <param name="eventType">One of the <see cref="T:System.Diagnostics.TraceEventType" /> values specifying the type of event that has caused the trace.</param>
88 <param name="id">A numeric identifier for the event.</param>
89 <param name="message">The trace message to write to the output file or stream.</param>
91 <member name="M:System.Diagnostics.DelimitedListTraceListener.TraceEvent(System.Diagnostics.TraceEventCache,System.String,System.Diagnostics.TraceEventType,System.Int32,System.String,System.Object[])">
92 <summary>Writes trace information, a formatted array of objects, and event information to the output file or stream.</summary>
93 <param name="eventCache">A <see cref="T:System.Diagnostics.TraceEventCache" /> object that contains the current process ID, thread ID, and stack trace information.</param>
94 <param name="source">A name used to identify the output, typically the name of the application that generated the trace event.</param>
95 <param name="eventType">One of the <see cref="T:System.Diagnostics.TraceEventType" /> values specifying the type of event that has caused the trace.</param>
96 <param name="id">A numeric identifier for the event.</param>
97 <param name="format">A format string that contains zero or more format items that correspond to objects in the <paramref name="args" /> array.</param>
98 <param name="args">An array containing zero or more objects to format.</param>
100 <member name="P:System.Diagnostics.DelimitedListTraceListener.Delimiter">
101 <summary>Gets or sets the delimiter for the delimited list.</summary>
102 <exception cref="T:System.ArgumentNullException">
103 <see cref="P:System.Diagnostics.DelimitedListTraceListener.Delimiter" /> is set to <see langword="null" />.</exception>
104 <exception cref="T:System.ArgumentException">
105 <see cref="P:System.Diagnostics.DelimitedListTraceListener.Delimiter" /> is set to an empty string ("").</exception>
106 <returns>The delimiter for the delimited list.</returns>
108 <member name="T:System.Diagnostics.TextWriterTraceListener">
109 <summary>Directs tracing or debugging output to a <see cref="T:System.IO.TextWriter" /> or to a <see cref="T:System.IO.Stream" />, such as <see cref="T:System.IO.FileStream" />.</summary>
111 <member name="M:System.Diagnostics.TextWriterTraceListener.#ctor">
112 <summary>Initializes a new instance of the <see cref="T:System.Diagnostics.TextWriterTraceListener" /> class with <see cref="T:System.IO.TextWriter" /> as the output recipient.</summary>
114 <member name="M:System.Diagnostics.TextWriterTraceListener.#ctor(System.IO.Stream)">
115 <summary>Initializes a new instance of the <see cref="T:System.Diagnostics.TextWriterTraceListener" /> class, using the stream as the recipient of the debugging and tracing output.</summary>
116 <param name="stream">A <see cref="T:System.IO.Stream" /> that represents the stream the <see cref="T:System.Diagnostics.TextWriterTraceListener" /> writes to.</param>
117 <exception cref="T:System.ArgumentNullException">The stream is <see langword="null" />.</exception>
119 <member name="M:System.Diagnostics.TextWriterTraceListener.#ctor(System.IO.Stream,System.String)">
120 <summary>Initializes a new instance of the <see cref="T:System.Diagnostics.TextWriterTraceListener" /> class with the specified name, using the stream as the recipient of the debugging and tracing output.</summary>
121 <param name="stream">A <see cref="T:System.IO.Stream" /> that represents the stream the <see cref="T:System.Diagnostics.TextWriterTraceListener" /> writes to.</param>
122 <param name="name">The name of the new instance.</param>
123 <exception cref="T:System.ArgumentNullException">The stream is <see langword="null" />.</exception>
125 <member name="M:System.Diagnostics.TextWriterTraceListener.#ctor(System.IO.TextWriter)">
126 <summary>Initializes a new instance of the <see cref="T:System.Diagnostics.TextWriterTraceListener" /> class using the specified writer as recipient of the tracing or debugging output.</summary>
127 <param name="writer">A <see cref="T:System.IO.TextWriter" /> that receives the output from the <see cref="T:System.Diagnostics.TextWriterTraceListener" />.</param>
128 <exception cref="T:System.ArgumentNullException">The writer is <see langword="null" />.</exception>
130 <member name="M:System.Diagnostics.TextWriterTraceListener.#ctor(System.IO.TextWriter,System.String)">
131 <summary>Initializes a new instance of the <see cref="T:System.Diagnostics.TextWriterTraceListener" /> class with the specified name, using the specified writer as recipient of the tracing or debugging output.</summary>
132 <param name="writer">A <see cref="T:System.IO.TextWriter" /> that receives the output from the <see cref="T:System.Diagnostics.TextWriterTraceListener" />.</param>
133 <param name="name">The name of the new instance.</param>
134 <exception cref="T:System.ArgumentNullException">The writer is <see langword="null" />.</exception>
136 <member name="M:System.Diagnostics.TextWriterTraceListener.#ctor(System.String)">
137 <summary>Initializes a new instance of the <see cref="T:System.Diagnostics.TextWriterTraceListener" /> class, using the file as the recipient of the debugging and tracing output.</summary>
138 <param name="fileName">The name of the file the <see cref="T:System.Diagnostics.TextWriterTraceListener" /> writes to.</param>
139 <exception cref="T:System.ArgumentNullException">The file is <see langword="null" />.</exception>
141 <member name="M:System.Diagnostics.TextWriterTraceListener.#ctor(System.String,System.String)">
142 <summary>Initializes a new instance of the <see cref="T:System.Diagnostics.TextWriterTraceListener" /> class with the specified name, using the file as the recipient of the debugging and tracing output.</summary>
143 <param name="fileName">The name of the file the <see cref="T:System.Diagnostics.TextWriterTraceListener" /> writes to.</param>
144 <param name="name">The name of the new instance.</param>
145 <exception cref="T:System.ArgumentNullException">The stream is <see langword="null" />.</exception>
147 <member name="M:System.Diagnostics.TextWriterTraceListener.Close">
148 <summary>Closes the <see cref="P:System.Diagnostics.TextWriterTraceListener.Writer" /> so that it no longer receives tracing or debugging output.</summary>
150 <member name="M:System.Diagnostics.TextWriterTraceListener.Dispose(System.Boolean)">
151 <summary>Disposes this <see cref="T:System.Diagnostics.TextWriterTraceListener" /> object.</summary>
152 <param name="disposing">
153 <see langword="true" /> to release managed resources; if <see langword="false" />, <see cref="M:System.Diagnostics.TextWriterTraceListener.Dispose(System.Boolean)" /> has no effect.</param>
155 <member name="M:System.Diagnostics.TextWriterTraceListener.Flush">
156 <summary>Flushes the output buffer for the <see cref="P:System.Diagnostics.TextWriterTraceListener.Writer" />.</summary>
158 <member name="M:System.Diagnostics.TextWriterTraceListener.Write(System.String)">
159 <summary>Writes a message to this instance's <see cref="P:System.Diagnostics.TextWriterTraceListener.Writer" />.</summary>
160 <param name="message">A message to write.</param>
162 <member name="M:System.Diagnostics.TextWriterTraceListener.WriteLine(System.String)">
163 <summary>Writes a message to this instance's <see cref="P:System.Diagnostics.TextWriterTraceListener.Writer" /> followed by a line terminator. The default line terminator is a carriage return followed by a line feed (\r\n).</summary>
164 <param name="message">A message to write.</param>
166 <member name="P:System.Diagnostics.TextWriterTraceListener.Writer">
167 <summary>Gets or sets the text writer that receives the tracing or debugging output.</summary>
168 <returns>A <see cref="T:System.IO.TextWriter" /> that represents the writer that receives the tracing or debugging output.</returns>
170 <member name="T:System.Diagnostics.XmlWriterTraceListener">
171 <summary>Directs tracing or debugging output as XML-encoded data to a <see cref="T:System.IO.TextWriter" /> or to a <see cref="T:System.IO.Stream" />, such as a <see cref="T:System.IO.FileStream" />.</summary>
173 <member name="M:System.Diagnostics.XmlWriterTraceListener.#ctor(System.IO.Stream)">
174 <summary>Initializes a new instance of the <see cref="T:System.Diagnostics.XmlWriterTraceListener" /> class, using the specified stream as the recipient of the debugging and tracing output.</summary>
175 <param name="stream">A <see cref="T:System.IO.Stream" /> that represents the stream the trace listener writes to.</param>
176 <exception cref="T:System.ArgumentNullException">
177 <paramref name="stream" /> is <see langword="null" />.</exception>
179 <member name="M:System.Diagnostics.XmlWriterTraceListener.#ctor(System.IO.Stream,System.String)">
180 <summary>Initializes a new instance of the <see cref="T:System.Diagnostics.XmlWriterTraceListener" /> class with the specified name, using the specified stream as the recipient of the debugging and tracing output.</summary>
181 <param name="stream">A <see cref="T:System.IO.Stream" /> that represents the stream the trace listener writes to.</param>
182 <param name="name">The name of the new instance.</param>
183 <exception cref="T:System.ArgumentNullException">
184 <paramref name="stream" /> is <see langword="null" />.</exception>
186 <member name="M:System.Diagnostics.XmlWriterTraceListener.#ctor(System.IO.TextWriter)">
187 <summary>Initializes a new instance of the <see cref="T:System.Diagnostics.XmlWriterTraceListener" /> class using the specified writer as the recipient of the debugging and tracing output.</summary>
188 <param name="writer">A <see cref="T:System.IO.TextWriter" /> that receives the output from the trace listener.</param>
189 <exception cref="T:System.ArgumentNullException">
190 <paramref name="writer" /> is <see langword="null" />.</exception>
192 <member name="M:System.Diagnostics.XmlWriterTraceListener.#ctor(System.IO.TextWriter,System.String)">
193 <summary>Initializes a new instance of the <see cref="T:System.Diagnostics.XmlWriterTraceListener" /> class with the specified name, using the specified writer as the recipient of the debugging and tracing output.</summary>
194 <param name="writer">A <see cref="T:System.IO.TextWriter" /> that receives the output from the trace listener.</param>
195 <param name="name">The name of the new instance.</param>
196 <exception cref="T:System.ArgumentNullException">
197 <paramref name="writer" /> is <see langword="null" />.</exception>
199 <member name="M:System.Diagnostics.XmlWriterTraceListener.#ctor(System.String)">
200 <summary>Initializes a new instance of the <see cref="T:System.Diagnostics.XmlWriterTraceListener" /> class, using the specified file as the recipient of the debugging and tracing output.</summary>
201 <param name="filename">The name of the file to write to.</param>
202 <exception cref="T:System.ArgumentNullException">
203 <paramref name="filename" /> is <see langword="null" />.</exception>
205 <member name="M:System.Diagnostics.XmlWriterTraceListener.#ctor(System.String,System.String)">
206 <summary>Initializes a new instance of the <see cref="T:System.Diagnostics.XmlWriterTraceListener" /> class with the specified name, using the specified file as the recipient of the debugging and tracing output.</summary>
207 <param name="filename">The name of the file to write to.</param>
208 <param name="name">The name of the new instance.</param>
209 <exception cref="T:System.ArgumentNullException">
210 <paramref name="stream" /> is <see langword="null" />.</exception>
212 <member name="M:System.Diagnostics.XmlWriterTraceListener.Close">
213 <summary>Closes the <see cref="P:System.Diagnostics.TextWriterTraceListener.Writer" /> for this listener so that it no longer receives tracing or debugging output.</summary>
215 <member name="M:System.Diagnostics.XmlWriterTraceListener.Fail(System.String,System.String)">
216 <summary>Writes trace information including an error message and a detailed error message to the file or stream.</summary>
217 <param name="message">The error message to write.</param>
218 <param name="detailMessage">The detailed error message to append to the error message.</param>
220 <member name="M:System.Diagnostics.XmlWriterTraceListener.TraceData(System.Diagnostics.TraceEventCache,System.String,System.Diagnostics.TraceEventType,System.Int32,System.Object)">
221 <summary>Writes trace information, a data object, and event information to the file or stream.</summary>
222 <param name="eventCache">A <see cref="T:System.Diagnostics.TraceEventCache" /> that contains the current process ID, thread ID, and stack trace information.</param>
223 <param name="source">The source name.</param>
224 <param name="eventType">One of the <see cref="T:System.Diagnostics.TraceEventType" /> values.</param>
225 <param name="id">A numeric identifier for the event.</param>
226 <param name="data">A data object to emit.</param>
228 <member name="M:System.Diagnostics.XmlWriterTraceListener.TraceData(System.Diagnostics.TraceEventCache,System.String,System.Diagnostics.TraceEventType,System.Int32,System.Object[])">
229 <summary>Writes trace information, data objects, and event information to the file or stream.</summary>
230 <param name="eventCache">A <see cref="T:System.Diagnostics.TraceEventCache" /> that contains the current process ID, thread ID, and stack trace information.</param>
231 <param name="source">The source name.</param>
232 <param name="eventType">One of the <see cref="T:System.Diagnostics.TraceEventType" /> values.</param>
233 <param name="id">A numeric identifier for the event.</param>
234 <param name="data">An array of data objects to emit.</param>
236 <member name="M:System.Diagnostics.XmlWriterTraceListener.TraceEvent(System.Diagnostics.TraceEventCache,System.String,System.Diagnostics.TraceEventType,System.Int32,System.String)">
237 <summary>Writes trace information, a message, and event information to the file or stream.</summary>
238 <param name="eventCache">A <see cref="T:System.Diagnostics.TraceEventCache" /> that contains the current process ID, thread ID, and stack trace information.</param>
239 <param name="source">The source name.</param>
240 <param name="eventType">One of the <see cref="T:System.Diagnostics.TraceEventType" /> values.</param>
241 <param name="id">A numeric identifier for the event.</param>
242 <param name="message">The message to write.</param>
244 <member name="M:System.Diagnostics.XmlWriterTraceListener.TraceEvent(System.Diagnostics.TraceEventCache,System.String,System.Diagnostics.TraceEventType,System.Int32,System.String,System.Object[])">
245 <summary>Writes trace information, a formatted message, and event information to the file or stream.</summary>
246 <param name="eventCache">A <see cref="T:System.Diagnostics.TraceEventCache" /> that contains the current process ID, thread ID, and stack trace information.</param>
247 <param name="source">The source name.</param>
248 <param name="eventType">One of the <see cref="T:System.Diagnostics.TraceEventType" /> values.</param>
249 <param name="id">A numeric identifier for the event.</param>
250 <param name="format">A format string that contains zero or more format items that correspond to objects in the <paramref name="args" /> array.</param>
251 <param name="args">An object array containing zero or more objects to format.</param>
253 <member name="M:System.Diagnostics.XmlWriterTraceListener.TraceTransfer(System.Diagnostics.TraceEventCache,System.String,System.Int32,System.String,System.Guid)">
254 <summary>Writes trace information including the identity of a related activity, a message, and event information to the file or stream.</summary>
255 <param name="eventCache">A <see cref="T:System.Diagnostics.TraceEventCache" /> that contains the current process ID, thread ID, and stack trace information.</param>
256 <param name="source">The source name.</param>
257 <param name="id">A numeric identifier for the event.</param>
258 <param name="message">A trace message to write.</param>
259 <param name="relatedActivityId">A <see cref="T:System.Guid" /> structure that identifies a related activity.</param>
261 <member name="M:System.Diagnostics.XmlWriterTraceListener.Write(System.String)">
262 <summary>Writes a verbatim message without any additional context information to the file or stream.</summary>
263 <param name="message">The message to write.</param>
265 <member name="M:System.Diagnostics.XmlWriterTraceListener.WriteLine(System.String)">
266 <summary>Writes a verbatim message without any additional context information followed by the current line terminator to the file or stream.</summary>
267 <param name="message">The message to write.</param>