WorkflowApplicationCompletedEventArgs Class

.NET Framework 4.6 and 4.5

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

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

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

type WorkflowApplicationCompletedEventArgs =  
    class 
        inherit WorkflowApplicationEventArgs 
    end

The WorkflowApplicationCompletedEventArgs type exposes the following members.

  NameDescription
Public propertyCompletionStateGets the completion state of the workflow instance, which indicates whether the workflow instance completed successfully, was canceled, or faulted.
Public propertyInstanceIdThe unique identifier of the workflow instance. (Inherited from WorkflowApplicationEventArgs.)
Public propertyOutputsGets a dictionary that contains the values of OutArguments of the workflow instance’s root activity, keyed by argument name.
Public propertyTerminationExceptionGets the exception associated with the termination of the workflow instance.
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 methodGetInstanceExtensions(T)Gets the collection of extensions of the specified type. (Inherited from WorkflowApplicationEventArgs.)
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

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

Supported in: 4.6, 4.5, 4

.NET Framework Client Profile

Supported in: 4

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2015 Microsoft