TrackingWorkflowTerminatedEventArgs Class

Definition

Namespace:

System.Workflow.Runtime.Tracking

Assembly:

System.Workflow.Runtime.dll

Caution

The System.Workflow.* types are deprecated. Instead, please use the new types from System.Activities.*

Contains data associated with the termination of a workflow instance.

public ref class TrackingWorkflowTerminatedEventArgs : EventArgs

[System.Serializable]
[System.Obsolete("The System.Workflow.* types are deprecated.  Instead, please use the new types from System.Activities.*")]
public class TrackingWorkflowTerminatedEventArgs : EventArgs

[<System.Serializable>]
[<System.Obsolete("The System.Workflow.* types are deprecated.  Instead, please use the new types from System.Activities.*")>]
type TrackingWorkflowTerminatedEventArgs = class
    inherit EventArgs

Public Class TrackingWorkflowTerminatedEventArgs
Inherits EventArgs

Inheritance

Object

EventArgs

TrackingWorkflowTerminatedEventArgs

Attributes

SerializableAttribute ObsoleteAttribute

Examples

The following code example demonstrates a method, named WriteTerminatedEventArgs, which captures a TrackingWorkflowTerminatedEventArgs. The code checks whether the Exception property is null (Nothing in Visual Basic). If it is not, the code writes the message associated with the Exception property to the console. If Exception is null (Nothing), the code does not write any exception information to the console.

This code example is part of the EventArgs Tracking SDK Sample from the Program.cs file. For more information, see EventArgs Tracking Sample.

static void WriteTerminatedEventArgs(string eventDescription, TrackingWorkflowTerminatedEventArgs terminatedEventArgs, DateTime eventDataTime)
{
    Console.WriteLine("\nTerminated Event Arguments Read From Tracking Database:\n");
    Console.WriteLine("EventDataTime: " + eventDataTime.ToString());
    Console.WriteLine("EventDescription: " + eventDescription);
    if (null != terminatedEventArgs.Exception)
    {
        Console.WriteLine("TerminatedEventArgs Exception Message: " + terminatedEventArgs.Exception.Message.ToString());
    }
}

Shared Sub WriteTerminatedEventArgs(ByVal eventDescription As String, ByVal terminatedEventArgs As TrackingWorkflowTerminatedEventArgs, ByVal eventDataTime As DateTime)
    Console.WriteLine(vbCrLf + "Terminated Event Arguments Read From Tracking Database:")
    Console.WriteLine("EventDataTime: " + eventDataTime.ToString(CultureInfo.CurrentCulture))
    Console.WriteLine("EventDescription: " + eventDescription)
    If terminatedEventArgs.Exception IsNot Nothing Then
        Console.WriteLine("TerminatedEventArgs Exception Message: " + terminatedEventArgs.Exception.Message.ToString())
    End If
End Sub

Remarks

Note

This material discusses types and namespaces that are obsolete. For more information, see Deprecated Types in Windows Workflow Foundation 4.5.

A TrackingWorkflowTerminatedEventArgs is generated by the runtime tracking infrastructure when a workflow instance is terminated. If the TrackingProfile associated with a workflow instance includes a WorkflowTrackPoint configured for a TerminatedTrackingWorkflowEvent, the workflow tracking infrastructure puts the TrackingWorkflowTerminatedEventArgs in EventArgs in the WorkflowTrackingRecord that it sends to the tracking service.

A workflow instance may be terminated in one of three ways: the host may call WorkflowInstance.Terminate; a TerminateActivity activity may be invoked from inside the workflow instance; or an unhandled exception may occur. If the workflow is terminated by the host or a TerminateActivity activity, the runtime tracking infrastructure sets Exception to a WorkflowTerminatedException that has its Message property set to a description of the reason for the termination. If the workflow is terminated because of an unhandled exception, the runtime tracking infrastructure passes the unhandled exception in Exception.

Note

TrackingWorkflowTerminatedEventArgs is used only by the runtime tracking service to pass information in a WorkflowTrackingRecord. The data for a WorkflowRuntime.WorkflowTerminated event is passed in a WorkflowTerminatedEventArgs.

Properties

Exception

Gets the exception that caused the workflow instance to be terminated.

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)

See also

• EventArgs Tracking Sample