DkmWorkList Classe

Definizione

Raccolta di elementi di lavoro asincroni elaborati insieme. Gli elementi di lavoro vengono aggiunti chiamando uno dei metodi asincroni in questa API. Gli elementi di lavoro possono essere aggiunti liberamente fino all'inizio dell'esecuzione dell'elenco di lavoro. Una volta avviata l'esecuzione, è possibile aggiungere un lavoro aggiuntivo solo dall'implementazione di un'interfaccia di elaborazione degli elementi di lavoro o da una routine di completamento.

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
Ereditarietà
DkmWorkList
Ereditarietà
DkmWorkList

Proprietà

IsCanceled

Questa proprietà consente a un componente di elaborare un elemento di lavoro per determinare se viene annullato o per una routine di completamento per determinare se l'operazione è stata annullata.

IsCurrentInstanceCanceled

Questa proprietà consente a un componente di determinare se l'operazione corrente deve essere annullata. Verrà restituito true quando viene chiamato da un thread che sta attualmente elaborando un elenco di lavoro e quando questo elenco di lavoro è stato annullato.

Verrà generato se viene chiamato da una routine di completamento o da un thread che attualmente non elabora una chiamata di interfaccia.

Metodi

BeginExecution()

Iniziare l'esecuzione degli elementi nell'elenco di lavoro. Questa API restituirà immediatamente e le routine di completamento vengono attivate per restituire i risultati. I callback verranno attivati come risultati completi (non ordinati).

Questo metodo può essere chiamato solo dal componente che ha creato l'oggetto.

BeginExecution(DkmWorkListExecutionThread)

Iniziare l'esecuzione degli elementi nell'elenco di lavoro. Questa API restituirà immediatamente e le routine di completamento vengono attivate per restituire i risultati. I callback verranno attivati come risultati completi (non ordinati).

Questo metodo può essere chiamato solo dal componente che ha creato l'oggetto.

Questa API è stata introdotta in Visual Studio 15 Update 5 (DkmApiVersion.VS15Update5).

BeginExecution(DkmWorkListExecutionThread, DkmWorkListPriority)

Iniziare l'esecuzione degli elementi nell'elenco di lavoro. Questa API restituirà immediatamente e le routine di completamento vengono attivate per restituire i risultati. I callback verranno attivati come risultati completi (non ordinati).

Questo metodo può essere chiamato solo dal componente che ha creato l'oggetto.

Questa API è stata introdotta in Visual Studio 15 Update 8 (DkmApiVersion.VS15Update8).

Cancel()

Annullare l'esecuzione di questo elenco di lavoro. Questa API restituirà una volta che tutte le operazioni in questa coda di lavoro sono state arrestate (l'elenco di lavoro viene annullato o completato). La richiesta viene ignorata se l'elenco di lavoro è già annullato. Questo metodo può essere chiamato solo dal componente che ha creato l'oggetto.

Nota per i componenti dichiarati come "Sincronizzati" nella configurazione del componente: la chiamata di questa API può rilasciare in modo implicito e quindi riacquisire il blocco intorno al componente. Tenere presente le possibili modifiche dello stato.

Cancel(Boolean)

Annullare l'esecuzione di questo elenco di lavoro. La richiesta viene ignorata se l'elenco di lavoro è già annullato. Questo metodo può essere chiamato solo dal componente che ha creato l'oggetto.

Questa API è stata aggiunta in Visual Studio 15 Update 7 (DkmApiVersion.VS15Update7)

Create(DkmWorkListCompletionRoutine)

Crea un nuovo oggetto elenco di lavoro vuoto. I chiamanti devono aggiungere operazioni all'elenco di lavoro e quindi avviare l'esecuzione ('BeginExecution' o 'Execute').

Una volta creato, un oggetto WorkList continuerà a esistere fino al completamento dell'esecuzione o fino a quando la richiesta non viene annullata. Pertanto, i chiamanti devono assicurarsi che "Annulla" venga chiamato nel caso di errore.

Create(DkmWorkListCompletionRoutine, DkmWorkListProgressRoutine)

Crea un nuovo oggetto elenco di lavoro vuoto. I chiamanti devono aggiungere operazioni all'elenco di lavoro e quindi avviare l'esecuzione ('BeginExecution' o 'Execute').

Una volta creato, un oggetto WorkList continuerà a esistere fino al completamento dell'esecuzione o fino a quando la richiesta non viene annullata. Pertanto, i chiamanti devono assicurarsi che "Annulla" venga chiamato nel caso di errore.

Execute()

Eseguire in modo sincrono tutti gli elementi nell'elenco di lavoro e restituire quando l'elaborazione è stata completata o è stata annullata, inclusa l'esecuzione di tutte le routine di completamento. I callback vengono attivati quando i risultati vengono completati (non ordinati).

Questo metodo può essere chiamato solo dal componente che ha creato l'oggetto. Questo metodo genererà se l'esecuzione è già in corso.

SetCurrentInstanceProgress(Boolean, Int32, String, String)

Imposta lo stato di avanzamento che verrà segnalato per l'elenco di lavoro attualmente in esecuzione. La creazione di report sullo stato di avanzamento non è supportata negli scenari di comunicazione remota.

Questa API è stata introdotta in Visual Studio 17 Update 6 (DkmApiVersion.VS17Update6).

SetDescription(String)

Imposta una stringa che può essere usata per descrivere le operazioni eseguite dall'elenco di lavoro. Questa operazione può essere visualizzata quando l'esecuzione di altre operazioni viene bloccata dall'elenco di lavoro.

Questa API è stata introdotta in Visual Studio 15 Update 7 (DkmApiVersion.VS15Update7).

SetProgress(Boolean, Int32, String, String)

Imposta lo stato di avanzamento che verrà segnalato per l'elenco di lavoro. La creazione di report sullo stato di avanzamento non è supportata negli scenari di comunicazione remota.

Questa API è stata introdotta in Visual Studio 17 Update 6 (DkmApiVersion.VS17Update6).

Si applica a