Compartilhar via


DkmWorkList Classe

Definição

Coleção de itens de trabalho assíncronos que são processados juntos. Os itens de trabalho são acrescentados chamando qualquer um dos métodos assíncronos em toda essa API. Os itens de trabalho podem ser acrescentados livremente até que a lista de trabalho inicie a execução. Depois que a execução for iniciada, o trabalho adicional só poderá ser acrescentado da implementação de uma interface de processamento de item de trabalho ou de uma rotina de conclusão.

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
Herança
DkmWorkList
Herança
DkmWorkList

Propriedades

IsCanceled

Essa propriedade permite que um componente que processe um item de trabalho determine se ele foi cancelado ou uma rotina de conclusão para determinar se a operação foi cancelada.

IsCurrentInstanceCanceled

Essa propriedade permite que um componente determine se a operação atual deve ser cancelada. Isso retornará true quando chamado de um thread que está processando atualmente uma lista de trabalho e quando essa lista de trabalho for cancelada.

Isso será gerado se for chamado de uma rotina de conclusão ou de um thread que não está processando uma chamada de interface no momento.

Métodos

BeginExecution()

Inicie a execução dos itens nesta lista de trabalho. Essa API retornará imediatamente e as rotinas de conclusão serão disparadas para retornar resultados. Os retornos de chamada serão disparados conforme os resultados forem concluídos (não ordenados).

Esse método só pode ser chamado pelo componente que criou o objeto .

BeginExecution(DkmWorkListExecutionThread)

Inicie a execução dos itens nesta lista de trabalho. Essa API retornará imediatamente e as rotinas de conclusão serão disparadas para retornar resultados. Os retornos de chamada serão disparados conforme os resultados forem concluídos (não ordenados).

Esse método só pode ser chamado pelo componente que criou o objeto .

Essa API foi introduzida no Visual Studio 15 Atualização 5 (DkmApiVersion.VS15Update5).

BeginExecution(DkmWorkListExecutionThread, DkmWorkListPriority)

Inicie a execução dos itens nesta lista de trabalho. Essa API retornará imediatamente e as rotinas de conclusão serão disparadas para retornar resultados. Os retornos de chamada serão disparados conforme os resultados forem concluídos (não ordenados).

Esse método só pode ser chamado pelo componente que criou o objeto .

Essa API foi introduzida no Visual Studio 15 Atualização 8 (DkmApiVersion.VS15Update8).

Cancel()

Cancele a execução desta lista de trabalho. Essa API retornará depois que todo o trabalho nessa fila de trabalho for interrompido (a lista de trabalho é cancelada ou concluída). A solicitação será ignorada se a lista de trabalho já estiver cancelada. Esse método só pode ser chamado pelo componente que criou o objeto .

Observação para componentes declarados como 'Sincronizados' na configuração do componente: chamar essa API pode liberar implicitamente e, em seguida, requisitar o bloqueio em torno do componente. Esteja atento às possíveis alterações de estado.

Cancel(Boolean)

Cancele a execução desta lista de trabalho. A solicitação será ignorada se a lista de trabalho já estiver cancelada. Esse método só pode ser chamado pelo componente que criou o objeto .

Essa API foi adicionada ao Visual Studio 15 Atualização 7 (DkmApiVersion.VS15Update7)

Create(DkmWorkListCompletionRoutine)

Cria um novo objeto de lista de trabalho vazio. Os chamadores devem acrescentar operações à lista de trabalho e, em seguida, iniciar a execução ('BeginExecution' ou 'Execute').

Depois de criado, um objeto WorkList continuará a existir até que sua execução seja concluída ou até que a solicitação seja cancelada. Portanto, os chamadores devem garantir que 'Cancelar' seja chamado no caso de falha.

Create(DkmWorkListCompletionRoutine, DkmWorkListProgressRoutine)

Cria um novo objeto de lista de trabalho vazio. Os chamadores devem acrescentar operações à lista de trabalho e, em seguida, iniciar a execução ('BeginExecution' ou 'Execute').

Depois de criado, um objeto WorkList continuará a existir até que sua execução seja concluída ou até que a solicitação seja cancelada. Portanto, os chamadores devem garantir que 'Cancelar' seja chamado no caso de falha.

Execute()

Execute de forma síncrona todos os itens na lista de trabalho e retorne quando o processamento for concluído ou tiver sido cancelado, incluindo o disparo de todas as rotinas de conclusão. Os retornos de chamada serão acionados à medida que os resultados forem concluídos (não ordenados).

Esse método só pode ser chamado pelo componente que criou o objeto . Esse método será lançado se a execução já estiver em andamento.

SetCurrentInstanceProgress(Boolean, Int32, String, String)

Define o progresso que será relatado para a lista de trabalho em execução no momento. Não há suporte para relatórios de progresso em cenários de comunicação remota.

Essa API foi introduzida no Visual Studio 17 Atualização 6 (DkmApiVersion.VS17Update6).

SetDescription(String)

Define uma cadeia de caracteres que pode ser usada para descrever as operações executadas pela lista de trabalho. Isso pode ser exibido quando a execução de outras operações é bloqueada por essa lista de trabalho.

Essa API foi introduzida no Visual Studio 15 Atualização 7 (DkmApiVersion.VS15Update7).

SetProgress(Boolean, Int32, String, String)

Define o progresso que será relatado para a lista de trabalho. Não há suporte para relatórios de progresso em cenários de comunicação remota.

Essa API foi introduzida no Visual Studio 17 Atualização 6 (DkmApiVersion.VS17Update6).

Aplica-se a