Функция WdfDpcCancel (wdfdpc.h)

  • Статья

[Относится только к KMDF]

Метод WdfDpcCancel пытается отменить выполнение запланированной функции обратного вызова EvtDpcFunc объекта DPC.

Синтаксис

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

Параметры

[in] Dpc

Дескриптор объекта DPC платформы.

[in] Wait

Логическое значение, которое, если значение TRUE, указывает, что метод WdfDpcCancel не будет возвращать, пока функция обратного вызова EvtDpcFunc объекта DPC не будет отменена или не завершит выполнение. Если значение РАВНО FALSE, метод WdfDpcCancel возвращается немедленно.

Возвращаемое значение

WdfDpcCancel возвращает значение TRUE , если функция обратного вызова EvtDpcFunc указанного объекта DPC находилась в очереди DPC системы. Метод возвращает значение FALSE , если функция обратного вызова не находилась в очереди DPC, либо потому, что функция обратного вызова выполнялась, либо потому, что она завершила выполнение.

Ошибка проверка возникает, если драйвер предоставляет недопустимый дескриптор объекта.

Комментарии

Если функция обратного вызова EvtDpcFunc указанного объекта DPC находится в системной очереди DPC, она удаляется из очереди. Если функция EvtDpcFunc отсутствует в очереди, она либо выполняется, либо завершает выполнение.

Если параметр Wait имеет значение TRUE, необходимо вызвать WdfDpcCancel по адресу IRQL = PASSIVE_LEVEL. Если параметр Wait имеет значение FALSE, WdfDpcCancel можно вызвать в любом IRQL.

Примеры

В следующем примере кода отменяется выполнение функции обратного вызова, связанной с объектом DPC, созданным в примере кода в разделе WdfDpcCreate .

WdfDpcCancel(
             PDevExt->CompleteWriteDpc,
             TRUE
             );

Требования

Требование Значение
Целевая платформа Универсальное
Минимальная версия KMDF 1,0
Верхняя часть wdfdpc.h (включая Wdf.h)
Библиотека Wdf01000.sys (см. раздел Управление версиями библиотеки Платформы).
IRQL См. раздел "Примечания".
Правила соответствия DDI DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf)

См. также раздел

EvtDpcFunc