EventSchemaTraceListener.TraceTransfer Method

Definition

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

public:
 override void TraceTransfer(System::Diagnostics::TraceEventCache ^ eventCache, System::String ^ source, int id, System::String ^ message, Guid relatedActivityId);
[System.Security.SecurityCritical]
public override void TraceTransfer (System.Diagnostics.TraceEventCache eventCache, string source, int id, string message, Guid relatedActivityId);
[<System.Security.SecurityCritical>]
override this.TraceTransfer : System.Diagnostics.TraceEventCache * string * int * string * Guid -> unit
Public Overrides Sub TraceTransfer (eventCache As TraceEventCache, source As String, id As Integer, message As String, relatedActivityId As Guid)

Parameters

eventCache
TraceEventCache

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

source
String

The source name.

id
Int32

A numeric identifier for the event.

message
String

A trace message to write.

relatedActivityId
Guid

A Guid structure that identifies a related activity.

Attributes

Remarks

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.

Important

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.

Applies to