WorkflowRuntime.GetWorkflow(Guid) Method

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.

Retrieves the workflow instance that has the specified Guid.

public:
 System::Workflow::Runtime::WorkflowInstance ^ GetWorkflow(Guid instanceId);

public System.Workflow.Runtime.WorkflowInstance GetWorkflow (Guid instanceId);

member this.GetWorkflow : Guid -> System.Workflow.Runtime.WorkflowInstance

Public Function GetWorkflow (instanceId As Guid) As WorkflowInstance

Parameters

instanceId: Guid

The Guid of a workflow instance.

Returns

WorkflowInstance

The WorkflowInstance that has the specified Guid.

Exceptions

InvalidOperationException

The workflow runtime is not started.

Examples

The following code example demonstrates a ReloadWorkflow method that calls the GetWorkflow method. The ReloadWorkflow method is part of a larger class that has a Runtime property to access all of the methods, properties, and events of the WorkflowRuntime class.

This code example is part of the Custom Persistence Service Sample sample.

Note

In the example, the call to Load is redundant because both the GetWorkflow and Load methods use the same internal helper method to load the workflow instance into memory.

private void ReloadWorkflow(object id)
{
    // Reload the workflow so that it will continue processing
    this.Runtime.GetWorkflow((Guid)id).Load();
}

Private Sub ReloadWorkflow(ByVal id As Object)
    ' Reload the workflow so that it will continue processing
    Me.Runtime.GetWorkflow(CType(id, Guid)).Load()
End Sub

Remarks

If instanceId specifies a workflow instance that is not currently in memory, the workflow instance is loaded into memory and scheduled for execution. For example, after a workflow instance is aborted, you can call GetWorkflow to load the workflow instance back into memory. In this case, the last persisted state of the workflow instance is loaded into memory by the persistence service.

Applies to

Share via