Suspends the workflow instance.
(in System.Workflow.Runtime.dll)
Visual Basic (Declaration)
Public Sub Suspend ( _
error As String _
)
Dim instance As WorkflowInstance
Dim error As String
instance.Suspend(error)
public void Suspend(
string error
)
public:
void Suspend(
String^ error
)
public function Suspend(
error : String
)
Parameters
- error
- Type: System..::.String
A description of the reason for suspending the workflow instance.
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.
.gif) Note: |
|---|
Suspend does not unload the workflow instance. |
The following code example demonstrates calling Suspend on a WorkflowInstance object.
' 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");
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.
.NET Framework
Supported in: 3.5, 3.0
Reference