Функция CloseThreadpoolTimer (threadpoolapiset.h)

Статья
03/13/2024

Освобождает указанный объект таймера.

Синтаксис

void CloseThreadpoolTimer(
  [in, out] PTP_TIMER pti
);

Параметры

[in, out] pti

Указатель на TP_TIMER структуру, определяющую объект таймера. Функция CreateThreadpoolTimer возвращает этот указатель.

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

None

Remarks

Объект таймера освобождается немедленно, если отсутствуют невыполненные обратные вызовы; В противном случае объект таймера освобождается асинхронно после завершения невыполненных функций обратного вызова.

В некоторых случаях функции обратного вызова могут выполняться после вызова CloseThreadpoolTimer . Чтобы предотвратить это, сделайте следующее:

Вызовите функцию SetThreadpoolTimer или Функцию SetThreadpoolTimerEx с параметром pftDueTime со значением NULL, а для параметров msPeriod и msWindowLength — значение 0.
Вызовите функцию WaitForThreadpoolTimerCallbacks с параметром fCancelPendingCallbacks , равным TRUE.
Вызовите CloseThreadpoolTimer.

Если с объектом таймера связана группа очистки, вызывать эту функцию не нужно; Вызов функции CloseThreadpoolCleanupGroupMembers освобождает объекты work, wait и timer, связанные с группой очистки.

Чтобы скомпилировать приложение, использующее эту функцию, определите _WIN32_WINNT как 0x0600 или выше.

Требования

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