.NET Framework Class Library
WorkflowCompletedEventArgs Class

Provides data for the WorkflowCompleted event.

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

Visual Basic (Declaration)
Public Class WorkflowCompletedEventArgs _
    Inherits WorkflowEventArgs
Visual Basic (Usage)
Dim instance As WorkflowCompletedEventArgs
C#
public class WorkflowCompletedEventArgs : WorkflowEventArgs
Visual C++
public ref class WorkflowCompletedEventArgs : public WorkflowEventArgs
JScript
public class WorkflowCompletedEventArgs extends WorkflowEventArgs
Remarks

When the workflow completes, the workflow runtime engine raises the WorkflowCompleted event. The workflow runtime engine passes all of the output parameters of the workflow in a WorkflowCompletedEventArgs. These include the out and ref parameters of the workflow.

Examples

The following code example demonstrates an event handler method that takes WorkflowCompletedEventArgs as a parameter. The OnWorkflowCompleted method is called when the WorkflowCompleted event is raised. The code uses the OutputParameters property to obtain the value associated with the Status key and writes it to the console.

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.

Visual Basic
Shared Sub OnWorkflowCompleted(ByVal sender As Object, ByVal e As WorkflowCompletedEventArgs)

    'The order status is stored in the "status" "out" parameter
    Dim orderStatus As String = e.OutputParameters("Status").ToString()
    Console.WriteLine("Order was " + orderStatus)
    waitHandle.Set()
End Sub
C#
static void OnWorkflowCompleted(object sender, WorkflowCompletedEventArgs e)
{
    //The order status is stored in the "status" "out" parameter
    string orderStatus = e.OutputParameters["Status"].ToString();
    Console.WriteLine("Order was " + orderStatus);
    waitHandle.Set();
}
Inheritance Hierarchy

System..::.Object
  System..::.EventArgs
    System.Workflow.Runtime..::.WorkflowEventArgs
      System.Workflow.Runtime..::.WorkflowCompletedEventArgs
Thread Safety

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

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.
Version Information

.NET Framework

Supported in: 3.5, 3.0
See Also

Reference

Other Resources

Tags :


Page view tracker