EventSchemaTraceListener.TraceTransfer Method (TraceEventCache, String, Int32, String, Guid)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Writes trace information, including the identity of a related activity, a message, and event information, to the log file.

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

<SecurityCriticalAttribute>
Public Overrides Sub TraceTransfer (
	eventCache As TraceEventCache,
	source As String,
	id As Integer,
	message As String,
	relatedActivityId As Guid
)

Parameters

eventCache
Type: System.Diagnostics.TraceEventCache

A TraceEventCache that contains the current process ID, thread ID, and stack trace information.

source
Type: System.String

The source name.

id
Type: System.Int32

A numeric identifier for the event.

message
Type: System.String

A trace message to write.

relatedActivityId
Type: System.Guid

A Guid structure that identifies a related activity.

The TraceTransfer method is used to correlate related traces. The eventCache, source, id, and relatedActivityId parameters are used in the header and footer of the trace. The id parameter is converted to an unsigned integer before it is written. Therefore, a negative id value is written as a large positive integer. The message parameter is written as the Data element. The Guid.ToString(String) method is called to convert the relatedActivityId value to a "B" formatted string, which appears in the header. The Opcode element in the footer identifies the trace event type as a Transfer.

System_CAPS_importantImportant

The TraceTransfer method should not be called by application code. It is intended to be used by a TraceSource object to emit the trace information for its TraceTransfer method.

.NET Framework
Available since 3.5
Return to top
Show: