Export (0) Print
Expand All

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

Note: This method is new in the .NET Framework version 2.0.

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
)
/** @attribute ConditionalAttribute("TRACE") */ 
public void TraceEvent (
	TraceEventType eventType, 
	int id, 
	String format, 
	Object[] args
)
ConditionalAttribute("TRACE") 
public function TraceEvent (
	eventType : TraceEventType, 
	id : int, 
	format : String, 
	... args : Object[]
)

Parameters

eventType

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

id

A numeric identifier for the event.

format

A format string that contains zero or more format items, which correspond to objects in the args array.

args

An object array containing zero or more objects to format.

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 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 is limited to a maximum id value of 65,535. If the id value specified is greater than 65,535, the EventLogTraceListener uses the maximum allowed value.

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");

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

.NET Framework

Supported in: 2.0

Community Additions

ADD
Show:
© 2014 Microsoft