Suspends the workflow instance.
Namespace: System.Workflow.Runtime
Assembly: System.Workflow.Runtime (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 void Suspend (
String error
)
public function Suspend (
error : String
)
Parameters
- error
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
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 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.
.NET Framework
Supported in: 3.0