TrackingWorkflowTerminatedEventArgs Class
Contains data associated with the termination of a workflow instance.
Assembly: System.Workflow.Runtime (in System.Workflow.Runtime.dll)
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. |
The following code example demonstrates a method, named WriteTerminatedEventArgs, which captures a TrackingWorkflowTerminatedEventArgs. The code checks whether the Exception property is Nothing (Nothing in Visual Basic). If it is not, the code writes the message associated with the Exception property to the console. If Exception is Nothing (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.
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
Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003
The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Note: