WorkflowApplication.Cancel 方法

定義

命名空間:

System.Activities

組件:

System.Activities.dll

取消工作流程執行個體。

多載

Cancel()	取消工作流程執行個體。
Cancel(TimeSpan)	取消使用指定逾時間隔的工作流程執行個體。

備註

此方法會排程工作流程執行個體的取消。 若要在取消完成時收到通知，請使用 Completed 控制代碼。

根據預設，取消作業必須在 30 秒內完成，否則會擲回 TimeoutException。

Cancel()

取消工作流程執行個體。

public:
 void Cancel();

public void Cancel ();

member this.Cancel : unit -> unit

Public Sub Cancel ()

範例

下列範例會使用 WorkflowApplication 來裝載工作流程。 系統會使用指定的工作流程定義來建構 WorkflowApplication 執行個體、處理所需的工作流程開發週期事件，並且透過呼叫 Run 叫用此工作流程。 啟動工作流程之後，就會呼叫 Cancel。 當工作流程取消時，主控台就會顯示下列輸出。

Starting the workflow.   
Workflow bcce00c2-d323-42c2-8c25-19ff0c4b6dac Idle.   
Workflow bcce00c2-d323-42c2-8c25-19ff0c4b6dac Canceled  
Workflow bcce00c2-d323-42c2-8c25-19ff0c4b6dac Unloaded.  

Activity wf = new Sequence
{
    Activities =
     {
         new WriteLine
         {
             Text = "Starting the workflow."
         },
         new Delay
         {
             Duration = TimeSpan.FromSeconds(5)
         },
         new WriteLine
         {
             Text = "Ending the workflow."
         }
     }
};

// Create a WorkflowApplication instance.
WorkflowApplication wfApp = new WorkflowApplication(wf);

// Subscribe to any desired workflow lifecycle events.
wfApp.Completed = delegate(WorkflowApplicationCompletedEventArgs e)
{
    if (e.CompletionState == ActivityInstanceState.Faulted)
    {
        Console.WriteLine("Workflow {0} Terminated.", e.InstanceId);
        Console.WriteLine("Exception: {0}\n{1}",
            e.TerminationException.GetType().FullName,
            e.TerminationException.Message);
    }
    else if (e.CompletionState == ActivityInstanceState.Canceled)
    {
        Console.WriteLine("Workflow {0} Canceled.", e.InstanceId);
    }
    else
    {
        Console.WriteLine("Workflow {0} Completed.", e.InstanceId);
    }
};

// Run the workflow.
wfApp.Run();

Thread.Sleep(TimeSpan.FromSeconds(1));

wfApp.Cancel();

備註

此方法會排程工作流程執行個體的取消。 若要在取消完成時收到通知，請使用 Completed 處理常式。

根據預設，取消作業必須在 30 秒內完成，否則會擲回 TimeoutException。

Cancel(TimeSpan)

取消使用指定逾時間隔的工作流程執行個體。

public:
 void Cancel(TimeSpan timeout);

public void Cancel (TimeSpan timeout);

member this.Cancel : TimeSpan -> unit

Public Sub Cancel (timeout As TimeSpan)

參數

timeout

TimeSpan

取消作業必須在作業取消並擲回 TimeoutException 前完成的間隔。

範例

下列範例會使用 WorkflowApplication 來裝載工作流程。 系統會使用指定的工作流程定義來建構 WorkflowApplication 執行個體、處理所需的工作流程開發週期事件，並且透過呼叫 Run 叫用此工作流程。 啟動工作流程之後，就會呼叫 Cancel。 當工作流程取消時，主控台就會顯示下列輸出。

Starting the workflow.   
Workflow bcce00c2-d323-42c2-8c25-19ff0c4b6dac Idle.   
Workflow bcce00c2-d323-42c2-8c25-19ff0c4b6dac Canceled  
Workflow bcce00c2-d323-42c2-8c25-19ff0c4b6dac Unloaded.  

Activity wf = new Sequence
{
    Activities =
     {
         new WriteLine
         {
             Text = "Starting the workflow."
         },
         new Delay
         {
             Duration = TimeSpan.FromSeconds(5)
         },
         new WriteLine
         {
             Text = "Ending the workflow."
         }
     }
};

// Create a WorkflowApplication instance.
WorkflowApplication wfApp = new WorkflowApplication(wf);

// Subscribe to any desired workflow lifecycle events.
wfApp.Completed = delegate(WorkflowApplicationCompletedEventArgs e)
{
    if (e.CompletionState == ActivityInstanceState.Faulted)
    {
        Console.WriteLine("Workflow {0} Terminated.", e.InstanceId);
        Console.WriteLine("Exception: {0}\n{1}",
            e.TerminationException.GetType().FullName,
            e.TerminationException.Message);
    }
    else if (e.CompletionState == ActivityInstanceState.Canceled)
    {
        Console.WriteLine("Workflow {0} Canceled.", e.InstanceId);
    }
    else
    {
        Console.WriteLine("Workflow {0} Completed.", e.InstanceId);
    }
};

// Run the workflow.
wfApp.Run();

Thread.Sleep(TimeSpan.FromSeconds(1));

wfApp.Cancel();

備註

此方法會排程工作流程執行個體的取消。 若要在取消完成時收到通知，請使用 Completed 處理常式。