WaitForThreadpoolTimerCallbacks function

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

Syntax

void WaitForThreadpoolTimerCallbacks(
  PTP_TIMER pti,
  BOOL      fCancelPendingCallbacks
);

Parameters

pti

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

fCancelPendingCallbacks

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

Return Value

This function does not return a value.

Remarks

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

Requirements

   
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 7, Windows Server 2008 Windows Server 2008 R2, Windows.h)
Library Kernel32.lib
DLL Kernel32.dll

See Also

CloseThreadpoolTimer

CreateThreadpoolTimer

IsThreadpoolTimerSet

SetThreadpoolTimer

Thread Pools