DkmWorkList 類別

定義

命名空間:

Microsoft.VisualStudio.Debugger

組件:

Microsoft.VisualStudio.Debugger.Engine.dll

套件:

Microsoft.VisualStudio.Debugger.Engine v17.8.1101801

一起處理的異步工作專案集合。 工作專案會透過在此 API 中呼叫任何異步方法來附加。 工作專案可以自由附加，直到工作清單開始執行為止。 一旦開始執行，其他工作只能從工作專案處理介面的實作，或從完成例程附加。

public ref class DkmWorkList sealed : MarshalByRefObject

public sealed class DkmWorkList

type DkmWorkList = class

Public NotInheritable Class DkmWorkList

繼承

Object

DkmWorkList

屬性

IsCanceled	這個屬性可讓處理工作專案的元件判斷是否已取消，或讓完成例程判斷作業是否已取消。
IsCurrentInstanceCanceled	這個屬性可讓元件判斷目前作業是否應該取消。 當從目前正在處理工作清單的線程呼叫時，以及取消此工作清單時，這會傳回 true。 如果從完成例程或目前未處理介面呼叫的線程呼叫，就會擲回這個方法。

方法

BeginExecution()	開始執行此工作清單中的專案。 此 API 會立即傳回，並引發完成例程以傳回結果。 回呼會在結果完成 (未排序) 時引發。 這個方法只能由建立 物件的元件呼叫。
BeginExecution(DkmWorkListExecutionThread)	開始執行此工作清單中的專案。 此 API 會立即傳回，並引發完成例程以傳回結果。 回呼會在結果完成 (未排序) 時引發。 這個方法只能由建立 物件的元件呼叫。 此 API 是在 Visual Studio 15 Update 5 (DkmApiVersion.VS15Update5) 引進。
BeginExecution(DkmWorkListExecutionThread, DkmWorkListPriority)	開始執行此工作清單中的專案。 此 API 會立即傳回，並引發完成例程以傳回結果。 回呼會在結果完成 (未排序) 時引發。 這個方法只能由建立 物件的元件呼叫。 此 API 是在 Visual Studio 15 Update 8 (DkmApiVersion.VS15Update8) 引進。
Cancel()	取消執行此工作清單。 此 API 會在此工作佇列上的所有工作停止後傳回， (工作清單已取消或完成) 。 如果工作清單已經取消，則會忽略要求。 這個方法只能由建立 物件的元件呼叫。 請注意，在元件元件組態中宣告為「同步處理」的元件：呼叫此 API 可能會隱含釋放，然後重新取得您元件周圍的鎖定。 請留意可能的狀態變更。
Cancel(Boolean)	取消執行此工作清單。 如果工作清單已經取消，則會忽略要求。 這個方法只能由建立 物件的元件呼叫。 此 API 已新增至 Visual Studio 15 Update 7 (DkmApiVersion.VS15Update7)
Create(DkmWorkListCompletionRoutine)	建立新的空白工作清單物件。 呼叫端應該將作業附加至工作清單，然後開始執行 (『BeginExecution』 或 『Execute』) 。 建立之後，WorkList 物件會繼續存在，直到其執行完成，或直到要求取消為止。 因此，呼叫端應該確保發生失敗時會呼叫 『Cancel』。
Create(DkmWorkListCompletionRoutine, DkmWorkListProgressRoutine)	建立新的空白工作清單物件。 呼叫端應該將作業附加至工作清單，然後開始執行 (『BeginExecution』 或 『Execute』) 。 建立之後，WorkList 物件會繼續存在，直到其執行完成，或直到要求取消為止。 因此，呼叫端應該確保發生失敗時會呼叫 『Cancel』。
Execute()	同步執行工作清單中的所有專案，並在處理完成或已取消時傳回，包括引發所有完成例程。 回呼會在結果完成 (未排序) 時引發。 這個方法只能由建立 物件的元件呼叫。 如果執行正在進行中，這個方法將會擲回。
SetCurrentInstanceProgress(Boolean, Int32, String, String)	設定目前正在執行的工作清單所報告的進度。 遠端處理案例不支持進度報告。 此 API 是在 Visual Studio 17 Update 6 (DkmApiVersion.VS17Update6) 引進。
SetDescription(String)	設定字串，這個字串可用來描述工作清單所執行之作業 () 。 當此工作清單封鎖執行其他作業時，即可顯示此作業。 此 API 是在 Visual Studio 15 Update 7 (DkmApiVersion.VS15Update7) 中引進。
SetProgress(Boolean, Int32, String, String)	設定將報告工作清單的進度。 遠端處理案例不支持進度報告。 此 API 是在 Visual Studio 17 Update 6 (DkmApiVersion.VS17Update6) 引進。