WorkflowTerminatedEventArgs Class

Reference

Definition

Namespace:: System.Workflow.Runtime

Assembly:: System.Workflow.Runtime.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Caution

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

Provides data for the WorkflowTerminated event.

public ref class WorkflowTerminatedEventArgs : System::Workflow::Runtime::WorkflowEventArgs

public class WorkflowTerminatedEventArgs : System.Workflow.Runtime.WorkflowEventArgs

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

type WorkflowTerminatedEventArgs = class
    inherit WorkflowEventArgs

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

Public Class WorkflowTerminatedEventArgs
Inherits WorkflowEventArgs

Inheritance: Object

EventArgs

WorkflowEventArgs
WorkflowTerminatedEventArgs

Attributes: ObsoleteAttribute

Examples

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 Workflow with Parameters Sample.

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

Shared Sub OnWorkflowTerminated(ByVal sender As Object, ByVal e As WorkflowTerminatedEventArgs)
    Console.WriteLine(e.Exception.Message)
    waitHandle.Set()
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 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.

Properties

Exception	Gets the exception that caused the workflow instance to be terminated.
WorkflowInstance	Gets the workflow instance associated with the workflow event. (Inherited from WorkflowEventArgs)

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)

Applies to

Share via