Expand Minimize

WaitForThreadpoolTimerCallbacks function

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

Syntax


VOID WINAPI WaitForThreadpoolTimerCallbacks(
  _Inout_  PTP_TIMER pti,
  _In_     BOOL fCancelPendingCallbacks
);

Parameters

pti [in, out]

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

fCancelPendingCallbacks [in]

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 only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

WinBase.h on Windows Vista, Windows 7, Windows Server 2008, and Windows Server 2008 R2 (include Windows.h);
Threadpoolapiset.h on Windows 8 and Windows Server 2012

Library

Kernel32.lib

DLL

Kernel32.dll

See also

CloseThreadpoolTimer
CreateThreadpoolTimer
IsThreadpoolTimerSet
SetThreadpoolTimer
Thread Pools

 

 

Community Additions

ADD
Show:
© 2014 Microsoft