WorkflowTerminatedEventArgs Class

Note: This API is now obsolete.

Provides data for the WorkflowRuntime.WorkflowTerminated event.

System.Object
  System.EventArgs
    System.Workflow.Runtime.WorkflowEventArgs
      System.Workflow.Runtime.WorkflowTerminatedEventArgs

Namespace:  System.Workflow.Runtime
Assembly:  System.Workflow.Runtime (in System.Workflow.Runtime.dll)

[ObsoleteAttribute("The System.Workflow.* types are deprecated.  Instead, please use the new types from System.Activities.*")]
public class WorkflowTerminatedEventArgs : WorkflowEventArgs

The WorkflowTerminatedEventArgs type exposes the following members.

  NameDescription
Public propertyExceptionGets the exception that caused the workflow instance to be terminated.
Public propertyWorkflowInstanceGets the workflow instance associated with the workflow event. (Inherited from WorkflowEventArgs.)
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

NoteNote

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

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 the workflow runtime engine may terminate the instance because of an unhandled exception. When the workflow instance is terminated, the workflow runtime engine raises the WorkflowRuntime.WorkflowTerminated event. The host may subscribe to this event by adding an event handler to WorkflowRuntime.WorkflowTerminated.

The following code example demonstrates an event handler method that takes WorkflowTerminatedEventArgs as a parameter. The OnWorkflowTerminated method is called when the WorkflowTerminated event is raised. The code uses the Exception property get the message associated with the exception that caused the workflow to terminate.

This code example is part of the Sequential Workflow with Parameters SDK Sample from the Program.cs file. For more information, see Sequential Workflow with Parameters.

static void OnWorkflowTerminated(object sender, WorkflowTerminatedEventArgs e)
{
    Console.WriteLine(e.Exception.Message);
    waitHandle.Set();
}

.NET Framework

Supported in: 4, 3.5, 3.0
Obsolete (compiler warning) in 4.6
Obsolete (compiler warning) in 4.5
Obsolete (compiler warning) in 4.5.1
Obsolete (compiler warning) in 4.5.2

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft