Função WdfDpcCancel (wdfdpc.h)

[Aplica-se somente ao KMDF]

O método WdfDpcCancel tenta cancelar a execução da função de retorno de chamada EvtDpcFunc agendada de um objeto DPC.

Sintaxe

BOOLEAN WdfDpcCancel(
  [in] WDFDPC  Dpc,
  [in] BOOLEAN Wait
);

Parâmetros

[in] Dpc

Um identificador para um objeto DPC de estrutura.

[in] Wait

Um valor booliano que, se TRUE, indica que o método WdfDpcCancel não retornará até que a função de retorno de chamada EvtDpcFunc do objeto DPC seja cancelada ou termine de ser executada. Se FALSE, o método WdfDpcCancel retornará imediatamente.

Retornar valor

WdfDpcCancel retornará TRUE se a função de retorno de chamada EvtDpcFunc do objeto DPC especificada estiver na fila DPC do sistema. O método retornará FALSE se a função de retorno de chamada não estiver na fila DPC, porque a função de retorno de chamada estava em execução ou porque tinha terminado de ser executada.

Um bug marcar ocorrerá se o driver fornecer um identificador de objeto inválido.

Comentários

Se a função de retorno de chamada EvtDpcFunc do objeto DPC especificada estiver na fila DPC do sistema, ela será removida da fila. Se a função EvtDpcFunc não estiver na fila, ela está em execução ou terminou a execução.

Se o parâmetro Wait for TRUE, WdfDpcCancel deverá ser chamado em IRQL = PASSIVE_LEVEL. Se o parâmetro Wait for FALSE, WdfDpcCancel poderá ser chamado em qualquer IRQL.

Exemplos

O exemplo de código a seguir cancela a execução da função de retorno de chamada associada ao objeto DPC que o exemplo de código no tópico WdfDpcCreate criou.

WdfDpcCancel(
             PDevExt->CompleteWriteDpc,
             TRUE
             );

Requisitos

Requisito	Valor
Plataforma de Destino	Universal
Versão mínima do KMDF	1.0
Cabeçalho	wdfdpc.h (inclua Wdf.h)
Biblioteca	Wdf01000.sys (consulte Controle de versão da biblioteca de estrutura.)
IRQL	Consulte a seção Observações.
Regras de conformidade de DDI	DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf)

Confira também

EvtDpcFunc