Expand Minimize

CreateThreadpoolTimer function

Creates a new timer object.

Syntax


PTP_TIMER WINAPI CreateThreadpoolTimer(
  _In_         PTP_TIMER_CALLBACK pfnti,
  _Inout_opt_  PVOID pv,
  _In_opt_     PTP_CALLBACK_ENVIRON pcbe
);

Parameters

pfnti [in]

The callback function to call each time the timer object expires. For details, see TimerCallback.

pv [in, out, optional]

Optional application-defined data to pass to the callback function.

pcbe [in, optional]

A TP_CALLBACK_ENVIRON structure that defines the environment in which to execute the callback. The InitializeThreadpoolEnvironment function returns this structure.

If this parameter is NULL, the callback executes in the default callback environment. For more information, see InitializeThreadpoolEnvironment.

Return value

If the function succeeds, it returns a TP_TIMER structure that defines the timer object. Applications do not modify the members of this structure.

If the function fails, it returns NULL. To retrieve extended error information, call GetLastError.

Remarks

To set the timer object, call the SetThreadpoolTimer function.

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

Examples

For an example, see Using the Thread Pool Functions.

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
IsThreadpoolTimerSet
SetThreadpoolTimer
Thread Pools
WaitForThreadpoolTimerCallbacks

 

 

Community Additions

ADD
Show:
© 2014 Microsoft