TraceSource.TraceEvent Method

Definition

Writes a trace event message to the trace listeners in the Listeners collection.

Overloads

TraceEvent(TraceEventType, Int32)

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

TraceEvent(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.

TraceEvent(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.

TraceEvent(TraceEventType, Int32)

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

public:
 void TraceEvent(System::Diagnostics::TraceEventType eventType, int id);
[System.Diagnostics.Conditional("TRACE")]
public void TraceEvent (System.Diagnostics.TraceEventType eventType, int id);
[<System.Diagnostics.Conditional("TRACE")>]
member this.TraceEvent : System.Diagnostics.TraceEventType * int -> unit
Public Sub TraceEvent (eventType As TraceEventType, id As Integer)

Parameters

eventType
TraceEventType

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

id
Int32

A numeric identifier for the event.

Attributes

Exceptions

An attempt was made to trace an event during finalization.

Examples

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.

ts.TraceEvent(TraceEventType.Warning, 1);
ts.TraceEvent(TraceEventType.Warning, 1)

Remarks

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, and the event type. Additional trace content is dependent upon the listener's TraceOutputOptions property value.

Note

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 uses 65,535.

Applies to

TraceEvent(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.

public:
 void TraceEvent(System::Diagnostics::TraceEventType eventType, int id, System::String ^ message);
[System.Diagnostics.Conditional("TRACE")]
public void TraceEvent (System.Diagnostics.TraceEventType eventType, int id, string? message);
[System.Diagnostics.Conditional("TRACE")]
public void TraceEvent (System.Diagnostics.TraceEventType eventType, int id, string message);
[<System.Diagnostics.Conditional("TRACE")>]
member this.TraceEvent : System.Diagnostics.TraceEventType * int * string -> unit
Public Sub TraceEvent (eventType As TraceEventType, id As Integer, message As String)

Parameters

eventType
TraceEventType

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

id
Int32

A numeric identifier for the event.

message
String

The trace message to write.

Attributes

Exceptions

An attempt was made to trace an event during finalization.

Examples

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

Remarks

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.

Note

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.

Applies to

TraceEvent(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.

public:
 void TraceEvent(System::Diagnostics::TraceEventType eventType, int id, System::String ^ format, ... cli::array <System::Object ^> ^ args);
[System.Diagnostics.Conditional("TRACE")]
public void TraceEvent (System.Diagnostics.TraceEventType eventType, int id, string format, params object?[]? args);
[System.Diagnostics.Conditional("TRACE")]
public void TraceEvent (System.Diagnostics.TraceEventType eventType, int id, string? format, params object?[]? args);
[System.Diagnostics.Conditional("TRACE")]
public void TraceEvent (System.Diagnostics.TraceEventType eventType, int id, string format, params object[] args);
[<System.Diagnostics.Conditional("TRACE")>]
member this.TraceEvent : System.Diagnostics.TraceEventType * int * string * obj[] -> unit
Public Sub TraceEvent (eventType As TraceEventType, id As Integer, format As String, ParamArray args As Object())

Parameters

eventType
TraceEventType

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

id
Int32

A numeric identifier for the event.

format
String

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

args
Object[]

An object array containing zero or more objects to format.

Attributes

Exceptions

format is null.

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.

An attempt was made to trace an event during finalization.

Examples

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");
' Issue file not found message as a verbose event using a formatted string.
ts.TraceEvent(TraceEventType.Verbose, 3, "File {0} not found.", "test")

Remarks

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.

Note

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.

See also

Applies to