Windows apps
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

WorkflowInstance::Suspend Method (String^)

 

Suspends the workflow instance.

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

public:
void Suspend(
	String^ error
)

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.

System_CAPS_noteNote

Suspend does not unload the workflow instance.

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

No code example is currently available or this language may not be supported.

.NET Framework
Available since 3.0
Return to top
Show:
© 2017 Microsoft