Функция ExCancelTimer (wdm.h)

Подпрограмма ExCancelTimer отменяет таймер, заданный при предыдущем вызове подпрограммы ExSetTimer .

Синтаксис

BOOLEAN ExCancelTimer(
  [in, out]      PEX_TIMER              Timer,
  [in, optional] PEXT_CANCEL_PARAMETERS Parameters
);

Параметры

[in, out] Timer

Указатель на структуру EX_TIMER . Эта структура представляет собой объект таймера, который ранее был выделен подпрограммой ExAllocateTimer .

[in, optional] Parameters

Драйверы должны задать для этого параметра значение NULL.

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

Эта подпрограмма возвращает значение TRUE , если таймер был отменен. В противном случае подпрограмма возвращает значение FALSE.

Комментарии

После того как драйвер вызывает подпрограмму ExSetTimer для установки таймера, таймер может быть отменен до истечения срока его действия. Драйвер может вызвать подпрограмму ExCancelTimer для явной отмены ожидающего таймера. Кроме того, если драйвер вызывает подпрограмму ExSetTimer для установки нового таймера для объекта таймера до истечения срока действия ранее заданного таймера для этого объекта, этот вызов ExSetTimer неявно отменяет предыдущий таймер, а затем запускает новый таймер.

Возвращаемое значение TRUE указывает, что таймер был задан при вызове ExCancelTimer . В этом случае подпрограмма отменяет таймер. Возвращаемое значение FALSE указывает, что таймер не задан, что может означать, что таймер никогда не устанавливался, что таймер уже был отменен или таймер уже истек.

По истечении срока действия таймера операционная система сообщает объекту таймера. В качестве варианта драйвер может предоставить подпрограмму обратного вызова ExTimerCallback , которая вызывается по истечении срока действия таймера. Если драйвер предоставляет эту подпрограмму обратного вызова, эта подпрограмма гарантированно будет вызвана при сигнале объекта таймера. Если таймер отменяется до истечения срока его действия, объект таймера не получает сигнал и подпрограмма обратного вызова не вызывается.

Дополнительные сведения см. в разделе Подпрограммы ExXxxTimer и объекты EX_TIMER.

Требования

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

EX_TIMER

ExAllocateTimer

ExSetTimer