DkmWorkList Klasa

Definicja

Kolekcja asynchronicznych elementów roboczych, które są przetwarzane razem. Elementy robocze są dołączane przez wywołanie dowolnych metod asynchronicznych w całym interfejsie API. Elementy robocze mogą być dołączane swobodnie do momentu rozpoczęcia wykonywania listy roboczej. Po rozpoczęciu wykonywania dodatkowe czynności mogą być dołączane tylko z implementacji interfejsu przetwarzania elementu pracy lub z procedury uzupełniania.

public ref class DkmWorkList sealed : MarshalByRefObject
public sealed class DkmWorkList : MarshalByRefObject
type DkmWorkList = class
    inherit MarshalByRefObject
Public NotInheritable Class DkmWorkList
Inherits MarshalByRefObject
Dziedziczenie
DkmWorkList

Właściwości

IsCanceled

Ta właściwość umożliwia składnikowi przetwarzanie elementu pracy w celu ustalenia, czy jest on anulowany, lub dla procedury uzupełniania, aby określić, czy operacja została anulowana.

IsCurrentInstanceCanceled

Ta właściwość umożliwia składnikowi ustalenie, czy bieżąca operacja powinna zostać anulowana. Spowoduje to zwrócenie wartości true w przypadku wywołania z wątku, który aktualnie przetwarza listę zadań, a następnie, gdy ta lista zadań została anulowana.

To zgłoszenie zostanie wykonane w przypadku wywołania z procedury zakończenia lub z wątku, który aktualnie nie przetwarza wywołania interfejsu.

Metody

BeginExecution()

Rozpocznij wykonywanie elementów na tej liście zadań. Ten interfejs API zwróci natychmiastowe, a procedury uzupełniające są generowane w celu zwrócenia wyników. Wywołania zwrotne będą wyzwalane jako ukończone (nieuporządkowane).

Ta metoda może być wywoływana tylko przez składnik, który utworzył obiekt.

BeginExecution(DkmWorkListExecutionThread)

Rozpocznij wykonywanie elementów na tej liście zadań. Ten interfejs API zwróci natychmiastowe, a procedury uzupełniające są generowane w celu zwrócenia wyników. Wywołania zwrotne będą wyzwalane jako ukończone (nieuporządkowane).

Ta metoda może być wywoływana tylko przez składnik, który utworzył obiekt.

Ten interfejs API został wprowadzony w programie Visual Studio 15 Update 5 (DkmApiVersion. VS15Update5).

BeginExecution(DkmWorkListExecutionThread, DkmWorkListPriority)

Rozpocznij wykonywanie elementów na tej liście zadań. Ten interfejs API zwróci natychmiastowe, a procedury uzupełniające są generowane w celu zwrócenia wyników. Wywołania zwrotne będą wyzwalane jako ukończone (nieuporządkowane).

Ta metoda może być wywoływana tylko przez składnik, który utworzył obiekt.

Ten interfejs API został wprowadzony w programie Visual Studio 15 Update 8 (DkmApiVersion. VS15Update8).

Cancel()

Anuluj wykonywanie tej listy zadań. Ten interfejs API zostanie zwrócony po zatrzymaniu wszystkich zadań w tej kolejce roboczej (Worklist zostanie anulowana lub ukończona). Żądanie jest ignorowane, jeśli lista zadań została już anulowana. Ta metoda może być wywoływana tylko przez składnik, który utworzył obiekt.

Uwaga dotycząca składników zadeklarowanych jako "Synchronized" w konfiguracji składnika: wywołanie tego interfejsu API może niejawnie zwolnić, a następnie ponownie uzyskać blokadę wokół składnika. Należy mieć na uwadze możliwe zmiany stanu.

Cancel(Boolean)

Anuluj wykonywanie tej listy zadań. Żądanie jest ignorowane, jeśli lista zadań została już anulowana. Ta metoda może być wywoływana tylko przez składnik, który utworzył obiekt.

Ten interfejs API został dodany w programie Visual Studio 15 Update 7 (DkmApiVersion. VS15Update7)

Create(DkmWorkListCompletionRoutine)

Tworzy nowy pusty obiekt listy roboczej. Obiekty wywołujące powinny dołączać operacje do listy zadań, a następnie rozpoczynać wykonywanie ("BeginExecution" lub "Execute").

Po utworzeniu obiekt WorkList będzie nadal istniał do momentu ukończenia jego wykonywania lub do momentu anulowania żądania. Dlatego obiekty wywołujące powinny mieć pewność, że element "Cancel" jest wywoływany w przypadku niepowodzenia.

Execute()

Synchronicznie wykonuj wszystkie elementy na liście zadań i zwróć, gdy przetwarzanie zostało zakończone lub zostało anulowane, w tym wyzwolenie wszystkich procedur uzupełniania. Wywołania zwrotne będą wyzwalane, gdy wyniki są zakończone (nieuporządkowane).

Ta metoda może być wywoływana tylko przez składnik, który utworzył obiekt. Ta metoda zostanie wygeneruje, jeśli wykonywanie jest już w toku.

SetDescription(String)

Ustawia ciąg, który może być używany do opisywania operacji wykonanych przez Worklist. Ten komunikat może być wyświetlany, gdy wykonywanie innych operacji jest blokowane przez ten Worklist.

Ten interfejs API został wprowadzony w programie Visual Studio 15 Update 7 (DkmApiVersion. VS15Update7).

Dotyczy