WorkflowTerminatedEventArgs Class

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Note: This API is now obsolete.

Provides data for the WorkflowRuntime.WorkflowTerminated event.

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

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

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

NameDescription
System_CAPS_pubpropertyException

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

System_CAPS_pubpropertyWorkflowInstance

Gets the workflow instance associated with the workflow event.(Inherited from WorkflowEventArgs.)

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_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
Available since 3.0

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

System.Workflow.Runtime Namespace
Sequential Workflow with Parameters

Return to top
Show: