Función WdfDpcCancel (wdfdpc.h)

[Solo se aplica a KMDF]

El método WdfDpcCancel intenta cancelar la ejecución de la función de devolución de llamada EvtDpcFunc programada de un objeto DPC.

Sintaxis

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

Parámetros

[in] Dpc

Identificador de un objeto DPC de marco.

[in] Wait

Valor booleano que, si es TRUE, indica que el método WdfDpcCancel no devolverá hasta que la función de devolución de llamada EvtDpcFunc del objeto DPC se cancele o termine de ejecutarse. Si es FALSE, el método WdfDpcCancel devuelve inmediatamente.

Valor devuelto

WdfDpcCancel devuelve TRUE si la función de devolución de llamada EvtDpcFunc del objeto DPC especificada estaba en la cola DPC del sistema. El método devuelve FALSE si la función de devolución de llamada no estaba en la cola DPC, ya sea porque la función de devolución de llamada se estaba ejecutando o porque había terminado de ejecutarse.

Se produce una comprobación de errores si el controlador proporciona un identificador de objeto no válido.

Comentarios

Si la función de devolución de llamada EvtDpcFunc del objeto DPC especificada se encuentra en la cola DPC del sistema, se quita de la cola. Si la función EvtDpcFunc no está en la cola, se está ejecutando o ha terminado de ejecutarse.

Si el parámetro Wait es TRUE, se debe llamar a WdfDpcCancel en IRQL = PASSIVE_LEVEL. Si el parámetro Wait es FALSE, se puede llamar a WdfDpcCancel en cualquier IRQL.

Ejemplos

En el ejemplo de código siguiente se cancela la ejecución de la función de devolución de llamada asociada al objeto DPC que el ejemplo de código del tema WdfDpcCreate creó.

WdfDpcCancel(
             PDevExt->CompleteWriteDpc,
             TRUE
             );

Requisitos

Requisito	Value
Plataforma de destino	Universal
Versión mínima de KMDF	1.0
Encabezado	wdfdpc.h (incluya Wdf.h)
Library	Wdf01000.sys (consulte Control de versiones de la biblioteca de marcos).
IRQL	vea la sección Comentarios.
Reglas de cumplimiento de DDI	DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf)

Consulte también

EvtDpcFunc