Функция CancelWaitableTimer (synchapi.h)

Статья
08/26/2023

Устанавливает для указанного таймера ожидания в неактивное состояние.

Синтаксис

BOOL CancelWaitableTimer(
  [in] HANDLE hTimer
);

Параметры

[in] hTimer

Дескриптор объекта таймера. Функция CreateWaitableTimer или OpenWaitableTimer возвращает этот дескриптор. Дескриптор должен иметь право доступа TIMER_MODIFY_STATE . Дополнительные сведения см. в разделе Безопасность объектов синхронизации и права доступа.

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

Если функция выполняется успешно, возвращается ненулевое значение.

Если функция выполняется неудачно, возвращается нулевое значение. Дополнительные сведения об ошибке можно получить, вызвав GetLastError.

Функция CancelWaitableTimer не изменяет сигнальное состояние таймера. Он останавливает таймер, прежде чем его можно будет присвоить сигнальное состояние, и отменяет неоплаченные APC. Таким образом, потоки, выполняющие операцию ожидания с таймером, остаются в ожидании, пока не истекает время ожидания или таймер повторно активируется и его состояние не будет задано в значение Signaled. Если таймер уже находится в состоянии сигнала, он остается в этом состоянии.

Чтобы повторно активировать таймер, вызовите функцию SetWaitableTimer .

Чтобы скомпилировать приложение, использующее эту функцию, определите _WIN32_WINNT как 0x0400 или более поздней версии. Дополнительные сведения см. в разделе Использование заголовков Windows.

Требования

Требование	Значение
Минимальная версия клиента	Windows XP [классические приложения \| Приложения UWP]
Минимальная версия сервера	Windows Server 2003 [классические приложения \| Приложения UWP]
Целевая платформа	Windows
Header	synchapi.h (включая Windows.h в Windows Server 2003, Windows Vista, Windows 7, Windows Server 2008 Windows Server 2008 R2)
Библиотека	Kernel32.lib
DLL	Kernel32.dll

См. также

CreateWaitableTimer

OpenWaitableTimer

SetWaitableTimer

Функции синхронизации

Объекты таймера для ожидания