WorkflowInstance.Suspend Method (System.Workflow.Runtime)

Suspend Method

Switch on low bandwidth view

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

WorkflowInstance..::.Suspend Method

Suspends the workflow instance.

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

Syntax

Visual Basic (Declaration)

Public Sub Suspend ( _
    error As String _
)

Visual Basic (Usage)

Dim instance As WorkflowInstance
Dim error As String

instance.Suspend(error)

public void Suspend(
    string error
)

Visual C++

public:
void Suspend(
    String^ error
)

JScript

public function Suspend(
    error : String
)

Parameters

error: Type: System..::.String
A description of the reason for suspending the workflow instance.

Exceptions

Exception	Condition
InvalidOperationException	The workflow runtime engine is not running.

Remarks

The workflow instance is suspended in a synchronous manner. If the workflow instance is already suspended, no action is taken; otherwise, the workflow runtime engine suspends the workflow instance, raises the WorkflowSuspended event and passes reason in a WorkflowSuspendedEventArgs.

Note:
Suspend does not unload the workflow instance.

Examples

The following code example demonstrates calling Suspend on a WorkflowInstance object.

Visual Basic

' Create a workflow runtime
Dim workflowRuntime As New WorkflowRuntime()
' Create a workflow instance
Dim workflowInstance As WorkflowInstance = workflowRuntime.CreateWorkflow(GetType(Workflow1))
' Start the workflow
workflowInstance.Start()
' Suspend the workflow, passing in a message
workflowInstance.Suspend("Workflow manually suspended")

// Create a workflow runtime
WorkflowRuntime workflowRuntime = new WorkflowRuntime();
// Create a workflow instance
WorkflowInstance workflowInstance = workflowRuntime.CreateWorkflow(typeof(Workflow1));
// Start the workflow
workflowInstance.Start();
// Suspend the workflow, passing in a message
workflowInstance.Suspend("Workflow manually suspended");

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

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

Reference

WorkflowInstance Class

WorkflowInstance Members

System.Workflow.Runtime Namespace