This documentation is archived and is not being maintained.

TraceSource.TraceEvent Method (TraceEventType, Int32, String)

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

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

[ConditionalAttribute("TRACE")] 
public void TraceEvent (
	TraceEventType eventType,
	int id,
	string message
)
/** @attribute ConditionalAttribute("TRACE") */ 
public void TraceEvent (
	TraceEventType eventType, 
	int id, 
	String message
)
ConditionalAttribute("TRACE") 
public function TraceEvent (
	eventType : TraceEventType, 
	id : int, 
	message : String
)
Not applicable.

Parameters

eventType

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

id

A numeric identifier for the event.

message

The trace message to write.

Exception typeCondition

ObjectDisposedException

An attempt was made to trace an event during finalization.

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. If the method is not overridden by the listener implementation, the default output is the name of the trace source, its numeric identity, the event type, and the message. Additional trace content is dependent upon the listener's TraceOutputOptions property value.

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 warning.
ts.TraceEvent(TraceEventType.Warning, 2, "File Test not found");

Windows 98, Windows Server 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 Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0
Show: