Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

WorkflowCompletedEventArgs Class

Note: This API is now obsolete.

Provides data for the WorkflowCompleted event.

System.Object
  System.EventArgs
    System.Workflow.Runtime.WorkflowEventArgs
      System.Workflow.Runtime.WorkflowCompletedEventArgs

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 WorkflowCompletedEventArgs : WorkflowEventArgs

The WorkflowCompletedEventArgs type exposes the following members.

  NameDescription
Public propertyOutputParametersGets the output from the workflow.
Public propertyWorkflowDefinitionGets an Activity that represents the workflow definition on completion of the workflow instance.
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.

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.

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.

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();
}

.NET Framework

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

Windows Phone 8.1, Windows Phone 8, 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.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.