TraceSource.TraceTransfer(Int32, String, Guid) TraceSource.TraceTransfer(Int32, String, Guid) TraceSource.TraceTransfer(Int32, String, Guid) TraceSource.TraceTransfer(Int32, String, Guid) Method

Definition

Writes a trace transfer message to the trace listeners in the Listeners collection using the specified numeric identifier, message, and related activity identifier.

public:
 void TraceTransfer(int id, System::String ^ message, Guid relatedActivityId);
[System.Diagnostics.Conditional("TRACE")]
public void TraceTransfer (int id, string message, Guid relatedActivityId);
member this.TraceTransfer : int * string * Guid -> unit
Public Sub TraceTransfer (id As Integer, message As String, relatedActivityId As Guid)

Parameters

id
Int32 Int32 Int32 Int32

A numeric identifier for the event.

message
String String String String

The trace message to write.

relatedActivityId
Guid Guid Guid Guid

A structure that identifies the related activity.

Remarks

The TraceTransfer method calls the TraceTransfer method of each trace listener in the Listeners property to write the trace information. The default TraceTransfer method in the base TraceListener class calls the TraceListener.TraceEvent(TraceEventCache, String, TraceEventType, Int32, String) method to process the call, setting eventType to TraceEventType.Transfer and appending a string representation of the relatedActivityId GUID to message.

TraceTransfer is intended to be used with the logical operations of a CorrelationManager. The relatedActivityId parameter relates to the ActivityId property of a CorrelationManager object. If a logical operation begins in one activity and transfers to another, the second activity logs the transfer by calling the TraceTransfer method. The TraceTransfer call relates the new activity identity to the previous identity. The most likely consumer of this functionality is a trace viewer that can report logical operations that span multiple activities.

Applies to

See also