WorkflowInstance.Terminate(String) WorkflowInstance.Terminate(String) WorkflowInstance.Terminate(String) WorkflowInstance.Terminate(String) Method

定義

ワークフロー インスタンスを同期式で終了します。Terminates the workflow instance in a synchronous manner.

public:
 void Terminate(System::String ^ error);
public void Terminate (string error);
member this.Terminate : string -> unit
Public Sub Terminate (error As String)

パラメーター

error
String String String String

ワークフロー インスタンスを終了する理由の説明。A description of the reason for terminating the workflow instance.

例外

ワークフロー ランタイム エンジンが実行されていません。The workflow runtime engine is not running.

WorkflowInstance オブジェクトに対する Terminate を呼び出す方法を次のコード例に示します。The following code example demonstrates calling Terminate 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();
// Terminate the workflow, passing in a message
workflowInstance.Terminate("Workflow manually terminated");
' 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()
' Terminate the workflow, passing in a message
workflowInstance.Terminate("Workflow manually terminated")

注釈

ワークフロー インスタンスは同期式で終了します。The workflow instance is terminated in a synchronous manner. ホストは Terminate を呼び出すことによってワークフロー インスタンスを終了します。The host calls Terminate to terminate the workflow instance. ワークフロー ランタイム エンジンは、メモリ内のワークフロー インスタンスをクリアし、インスタンスがメモリからクリアされたことを永続性サービスに通知します。The workflow runtime engine clears the in-memory workflow instance and informs the persistence service that the instance has been cleared from memory. SqlWorkflowPersistenceService の場合、これは、終了時にそのワークフロー インスタンスのすべての状態情報がデータベースから削除されることを意味します。For the SqlWorkflowPersistenceService, this means that all state information for that workflow instance is deleted from the database upon termination. 既に保存されている永続性ポイントからワークフロー インスタンスを再度読み込むことはできません。You will not be able to reload the workflow instance from a previously stored persistence point.

メモリ内のワークフロー インスタンスがクリアされて永続性サービスに終了が通知されると、Terminate メソッドは WorkflowTerminated イベントを発生させ、reason に含まれる MessageWorkflowTerminatedException プロパティに WorkflowTerminatedEventArgs を渡します。After the in-memory workflow instance is cleared and the persistence service is informed of the termination, the Terminate method raises the WorkflowTerminated event and passes reason in the Message property of a WorkflowTerminatedException contained in the WorkflowTerminatedEventArgs.

TerminateAbort と次の点で異なります。Terminate はメモリ内のワークフロー インスタンスをクリアして永続性サービスに終了を通知します。Abort はメモリ内のワークフロー インスタンスをクリアするだけで、最後の永続性ポイントからワークフロー インスタンスを再開できます。Terminate is different from Abort in that while Terminate clears the in-memory workflow instance and informs the persistence service of the termination, Abort simply clears the in-memory workflow instance, which can then be restarted from the last persistence point.

適用対象