TraceSource.TraceEvent Method (TraceEventType, Int32, String, Object[])

Writes a trace event to the trace listeners in the Listeners collection using the specified event type, event identifier, and argument array and format.

Namespace:  System.Diagnostics
Assembly:  System (in System.dll)

[ConditionalAttribute("TRACE")]
public void TraceEvent(
	TraceEventType eventType,
	int id,
	string format,
	params Object[] args
)

Parameters

eventType
Type: System.Diagnostics.TraceEventType

One of the enumeration values that specifies the event type of the trace data.

id
Type: System.Int32

A numeric identifier for the event.

format
Type: System.String

A composite format string (see Remarks) that contains text intermixed with zero or more format items, which correspond to objects in the args array.

args
Type: System.Object[]

An object array containing zero or more objects to format.

ExceptionCondition
ArgumentNullException

format is null.

FormatException

format is invalid.

-or-

The number that indicates an argument to format is less than zero, or greater than or equal to the number of specified objects to format.

ObjectDisposedException

An attempt was made to trace an event during finalization.

For more information about the format parameter, see Composite Formatting.

The TraceEvent method is intended to trace events that can be processed automatically by tools. For example, a monitoring tool can notify an administrator if a specific event is traced by a specific source.

The TraceEvent method calls the ShouldTrace method of the SourceSwitch object returned by the Switch property. If ShouldTrace returns true, TraceEvent calls the corresponding TraceEvent method of each listener. Otherwise, TraceEvent returns without calling the listeners' methods.

The trace content is listener specific. The default TraceEvent(TraceEventCache, String, TraceEventType, Int32, String, Object[]) method writes the source name, event type, and numeric identity in the trace header, then calls the String.Format(IFormatProvider, String, Object[]) method, passing the format string and args array and using the CultureInfo.InvariantCulture property to format the string as the message output.

NoteNote

The EventLogTraceListener object is limited to a maximum id value of 65,535. If the id value specified is greater than 65,535, the EventLogTraceListener object uses 65,535.

The following code example shows the use of the TraceEvent(TraceEventType, Int32) method to pass a trace event to the listeners. This code example is part of a larger example provided for the TraceSource class.

// Issue file not found message as a verbose event using a formatted string.
ts.TraceEvent(TraceEventType.Verbose, 3, "File {0} not found.", "test");

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft