Export (0) Print
Expand All

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
)

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.
message
Type: System.String
The trace message to write.

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


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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

Community Additions

ADD
Show:
© 2014 Microsoft