WaitForThreadpoolTimerCallbacks function (threadpoolapiset.h)

Waits for outstanding timer callbacks to complete and optionally cancels pending callbacks that have not yet started to execute.

Syntax

void WaitForThreadpoolTimerCallbacks(
  [in, out] PTP_TIMER pti,
  [in]      BOOL      fCancelPendingCallbacks
);

Parameters

[in, out] pti

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

[in] fCancelPendingCallbacks

Indicates whether to cancel queued callbacks that have not yet started to execute.

Return value

None

Remarks

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

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps | UWP apps]
Minimum supported server Windows Server 2008 [desktop apps | UWP apps]
Target Platform Windows
Header threadpoolapiset.h (include Windows.h on Windows 7, Windows Server 2008 Windows Server 2008 R2)
Library Kernel32.lib
DLL Kernel32.dll

See also

CloseThreadpoolTimer

CreateThreadpoolTimer

IsThreadpoolTimerSet

SetThreadpoolTimer

Thread Pools