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) で導入されました。