WorkflowApplicationCompletedEventArgs Class
TOC
Collapse the table of content
Expand the table of content

WorkflowApplicationCompletedEventArgs Class

.NET Framework (current version)
 

Provides information about a workflow instance that has completed its execution.

Namespace:   System.Activities
Assembly:  System.Activities (in System.Activities.dll)

System.Object
  System.EventArgs
    System.Activities.WorkflowApplicationEventArgs
      System.Activities.WorkflowApplicationCompletedEventArgs

public class WorkflowApplicationCompletedEventArgs : WorkflowApplicationEventArgs

NameDescription
System_CAPS_pubpropertyCompletionState

Gets the completion state of the workflow instance, which indicates whether the workflow instance completed successfully, was canceled, or faulted.

System_CAPS_pubpropertyInstanceId

The unique identifier of the workflow instance.(Inherited from WorkflowApplicationEventArgs.)

System_CAPS_pubpropertyOutputs

Gets a dictionary that contains the values of OutArguments of the workflow instance’s root activity, keyed by argument name.

System_CAPS_pubpropertyTerminationException

Gets the exception associated with the termination of the workflow instance.

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_pubmethodGetInstanceExtensions<T>()

Gets the collection of extensions of the specified type.(Inherited from WorkflowApplicationEventArgs.)

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.)

The following code example inspects the WorkflowApplicationCompletedEventArgs passed into the Completed handler of a WorkflowApplication instance and displays information about how the workflow completed.

wfApp.Completed = delegate(WorkflowApplicationCompletedEventArgs e)
{
    if (e.CompletionState == ActivityInstanceState.Faulted)
    {
        Console.WriteLine("Workflow {0} Terminated.", e.InstanceId);
        Console.WriteLine("Exception: {0}\n{1}",
            e.TerminationException.GetType().FullName,
            e.TerminationException.Message);
    }
    else if (e.CompletionState == ActivityInstanceState.Canceled)
    {
        Console.WriteLine("Workflow {0} Canceled.", e.InstanceId);
    }
    else
    {
        Console.WriteLine("Workflow {0} Completed.", e.InstanceId);

        // Retrieve the outputs of the workflow.
        foreach (var kvp in e.Outputs)
        {
            Console.WriteLine("Name: {0} - Value {1}",
                kvp.Key, kvp.Value);
        }

        // Outputs can be directly accessed by argument name.
        Console.WriteLine("The winner is {0}.", e.Outputs["Winner"]);
    }
};

.NET Framework
Available since 4.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.

Return to top
Show:
© 2016 Microsoft