TraceData Method (TraceEventType, Int32, Object)
Collapse the table of content
Expand the table of content

TraceSource.TraceData Method (TraceEventType, Int32, Object)

 

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

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

[ConditionalAttribute("TRACE")]
public void TraceData(
	TraceEventType eventType,
	int id,
	object data
)

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.

data
Type: System.Object

The trace data.

Exception Condition
ObjectDisposedException

An attempt was made to trace an event during finalization.

The TraceData method, like the TraceEvent method, is intended for automated tools, but it also allows the attaching of an additional object, such as an exception instance, to the trace.

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

System_CAPS_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 TraceData(TraceEventType, Int32, Object) method to filter and forward a trace message to the listeners. This code example is part of a larger example provided for the TraceSource class.

// Test the filter on the ConsoleTraceListener.
ts.Listeners["console"].Filter = new SourceFilter("No match");
ts.TraceData(TraceEventType.Error, 5,
    "SourceFilter should reject this message for the console trace listener.");
ts.Listeners["console"].Filter = new SourceFilter("TraceTest");
ts.TraceData(TraceEventType.Error, 6,
    "SourceFilter should let this message through on the console trace listener.");

.NET Framework
Available since 2.0
Return to top
Show:
© 2016 Microsoft