Sdílet prostřednictvím


DkmWorkList Třída

Definice

Kolekce asynchronních pracovních položek, které jsou zpracovávány společně. Pracovní položky se připojují voláním libovolné asynchronní metody v rámci tohoto rozhraní API. Pracovní položky mohou být připojeny volně, dokud se pracovní seznam nespustí. Po zahájení provádění může být další práce připojena pouze z implementace rozhraní pro zpracování pracovní položky nebo z rutiny dokončení.

public ref class DkmWorkList sealed : MarshalByRefObject
public sealed class DkmWorkList : MarshalByRefObject
public sealed class DkmWorkList
type DkmWorkList = class
    inherit MarshalByRefObject
type DkmWorkList = class
Public NotInheritable Class DkmWorkList
Inherits MarshalByRefObject
Public NotInheritable Class DkmWorkList
Dědičnost
DkmWorkList
Dědičnost
DkmWorkList

Vlastnosti

IsCanceled

Tato vlastnost umožňuje komponentě, která zpracovává pracovní položku, určit, jestli je zrušena, nebo pro rutinu dokončování, která určí, jestli byla operace zrušena.

IsCurrentInstanceCanceled

Tato vlastnost umožňuje komponentě určit, jestli má být aktuální operace zrušena. To vrátí hodnotu true při zavolání z vlákna, které právě zpracovává pracovní seznam, a když byl tento pracovní seznam zrušen.

To vyvolá volání z rutiny dokončení nebo z vlákna, které aktuálně nezpracovává volání rozhraní.

Metody

BeginExecution()

Začněte spouštět položky v tomto pracovním seznamu. Toto rozhraní API se okamžitě vrátí a rutiny dokončení se aktivují, aby se vrátily výsledky. Zpětná volání se aktivují, jakmile se výsledky dokončí (neuspořádané).

Tuto metodu může volat pouze komponenta, která objekt vytvořila.

BeginExecution(DkmWorkListExecutionThread)

Začněte spouštět položky v tomto pracovním seznamu. Toto rozhraní API se okamžitě vrátí a rutiny dokončení se aktivují, aby se vrátily výsledky. Zpětná volání se aktivují, jakmile se výsledky dokončí (neuspořádané).

Tuto metodu může volat pouze komponenta, která objekt vytvořila.

Toto rozhraní API bylo zavedeno v sadě Visual Studio 15 Update 5 (DkmApiVersion.VS15Update5).

BeginExecution(DkmWorkListExecutionThread, DkmWorkListPriority)

Začněte spouštět položky v tomto pracovním seznamu. Toto rozhraní API se okamžitě vrátí a rutiny dokončení se aktivují, aby se vrátily výsledky. Zpětná volání se aktivují, jakmile se výsledky dokončí (neuspořádané).

Tuto metodu může volat pouze komponenta, která objekt vytvořila.

Toto rozhraní API bylo zavedeno v sadě Visual Studio 15 Update 8 (DkmApiVersion.VS15Update8).

Cancel()

Zrušte provádění tohoto seznamu práce. Toto rozhraní API se vrátí, jakmile se zastaví veškerá práce na této pracovní frontě (pracovní seznam se zruší nebo dokončí). Pokud už je pracovní seznam zrušený, požadavek se ignoruje. Tuto metodu může volat pouze komponenta, která objekt vytvořila.

Poznámka pro komponenty deklarované jako Synchronizované v konfiguraci komponenty: Volání tohoto rozhraní API může implicitně uvolnit a pak znovu požádat o zámek kolem vaší komponenty. Mějte na paměti možné změny stavu.

Cancel(Boolean)

Zrušte provádění tohoto seznamu práce. Pokud už je pracovní seznam zrušený, požadavek se ignoruje. Tuto metodu může volat pouze komponenta, která objekt vytvořila.

Toto rozhraní API bylo přidáno v sadě Visual Studio 15 Update 7 (DkmApiVersion.VS15Update7)

Create(DkmWorkListCompletionRoutine)

Vytvoří nový prázdný objekt pracovního seznamu. Volající by měli k pracovnímu seznamu připojit operace a pak spustit provádění (BeginExecution nebo Execute).

Po vytvoření bude objekt WorkList dál existovat, dokud se jeho provedení nedokonči nebo dokud se požadavek nezruší. Volající by proto měli zajistit, aby se v případě selhání volala možnost Zrušit.

Create(DkmWorkListCompletionRoutine, DkmWorkListProgressRoutine)

Vytvoří nový prázdný objekt pracovního seznamu. Volající by měli k pracovnímu seznamu připojit operace a pak spustit provádění (BeginExecution nebo Execute).

Po vytvoření bude objekt WorkList dál existovat, dokud se jeho provedení nedokonči nebo dokud se požadavek nezruší. Volající by proto měli zajistit, aby se v případě selhání volala možnost Zrušit.

Execute()

Synchronně spouštět všechny položky v pracovním seznamu a vrátit se, když je zpracování dokončeno nebo bylo zrušeno, včetně aktivace všech rutin dokončení. Zpětná volání se aktivují, jakmile budou výsledky dokončené (neuspořádané).

Tuto metodu může volat pouze komponenta, která objekt vytvořila. Tato metoda vyvolá, pokud již probíhá provádění.

SetCurrentInstanceProgress(Boolean, Int32, String, String)

Nastaví průběh, který se bude hlásit pro aktuálně spouštěný pracovní seznam. Generování sestav průběhu se ve scénářích vzdálené komunikace nepodporuje.

Toto rozhraní API bylo zavedeno v sadě Visual Studio 17 Update 6 (DkmApiVersion.VS17Update6).

SetDescription(String)

Nastaví řetězec, který lze použít k popisu operací prováděných pracovním seznamem. To se může zobrazit, když tento pracovní seznam blokuje provádění jiných operací.

Toto rozhraní API bylo zavedeno v sadě Visual Studio 15 Update 7 (DkmApiVersion.VS15Update7).

SetProgress(Boolean, Int32, String, String)

Nastaví průběh, který se bude hlásit pro pracovní seznam. Generování sestav průběhu se ve scénářích vzdálené komunikace nepodporuje.

Toto rozhraní API bylo zavedeno v sadě Visual Studio 17 Update 6 (DkmApiVersion.VS17Update6).

Platí pro