WorkflowInstance.Suspend(String) メソッド

定義

名前空間:

System.Workflow.Runtime

アセンブリ:

System.Workflow.Runtime.dll

ワークフロー インスタンスを中断します。

public:
 void Suspend(System::String ^ error);

public void Suspend (string error);

member this.Suspend : string -> unit

Public Sub Suspend (error As String)

パラメーター

error

String

ワークフロー インスタンスを中断する理由の説明。

例外

InvalidOperationException

ワークフロー ランタイム エンジンが実行されていません。

例

WorkflowInstance オブジェクトに対する Suspend を呼び出す方法を次のコード例に示します。

// 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");

' 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")

注釈

ワークフロー インスタンスは同期式で中断されます。 ワークフロー インスタンスが既に中断している場合、アクションは実行されません。それ以外の場合、ワークフロー ランタイム エンジンはワークフロー インスタンスを中断し、WorkflowSuspended イベントを発生させ、reason に WorkflowSuspendedEventArgs を渡します。

注意

Suspend は、ワークフロー インスタンスをアンロードしません。