Функция 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 указывает, что таймер не задан, что может означать, что таймер никогда не был задан, что таймер уже был отменен или истек срок действия таймера. Если срок действия таймера истекает до отмены, ExCancelTimer возвращает значение FALSE, а таймер остается в сигнальном состоянии.
По истечении срока действия таймера операционная система сигнализирует объект таймера. В качестве параметра драйвер может предоставить exTimerCallback подпрограмму обратного вызова, вызываемую при истечении срока действия таймера. Если драйвер предоставляет эту подпрограмму обратного вызова, эта подпрограмма гарантированно вызывается, если объект таймера сигнализирует. Если таймер отменен до истечения срока действия, объект таймера не сигнализируется, а подпрограмма обратного вызова не вызывается.
Дополнительные сведения см. в подпрограммах ExXxxTimer и EX_TIMER объектах.
Требования
Требование | Ценность |
---|---|
минимальные поддерживаемые клиентские | Доступно начиная с Windows 8.1. |
целевая платформа | Всеобщий |
заголовка | wdm.h (include Wdm.h, Ntddk.h, Ntifs.h) |
библиотеки | Ntoskrnl.lib |
IRQL | <= DISPATCH_LEVEL |