WorkflowInstance.Suspend Method
Suspends the workflow instance.
Assembly: System.Workflow.Runtime (in System.Workflow.Runtime.dll)
Parameters
- error
- Type: System.String
A description of the reason for suspending the workflow instance.
| Exception | Condition |
|---|---|
| InvalidOperationException | The workflow runtime engine is not running. |
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. |
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");
- 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.
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.
Note: