CloseThreadpoolTimer function (threadpoolapiset.h)

Releases the specified timer object.

Syntax

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

Parameters

[in, out] pti

A pointer to TP_TIMER structure that defines the timer object. The CreateThreadpoolTimer function returns this pointer.

Return value

None

Remarks

The timer object is freed immediately if there are no outstanding callbacks; otherwise, the timer object is freed asynchronously after the outstanding callback functions complete.

In some cases, callback functions might run after CloseThreadpoolTimer has been called. To prevent this behavior:

• Call the SetThreadpoolTimer function or SetThreadpoolTimerEx function with the pftDueTime parameter set to NULL and the msPeriod and msWindowLength parameters set to 0.
• Call the WaitForThreadpoolTimerCallbacks function with the fCancelPendingCallbacks parameter set to TRUE.
• Call CloseThreadpoolTimer.

If there is a cleanup group associated with the timer object, it is not necessary to call this function; calling the CloseThreadpoolCleanupGroupMembers function releases the work, wait, and timer objects associated with the cleanup group.

To compile an application that uses this function, define _WIN32_WINNT as 0x0600 or higher.

Requirements

See also

CreateThreadpoolTimer

IsThreadpoolTimerSet

SetThreadpoolTimer

SetThreadpoolTimerEx

Thread Pools

WaitForThreadpoolTimerCallbacks