CreateThreadpoolTimer

Creates a new timer object.

Syntax

PTP_TIMER CreateThreadpoolTimer(
         PTP_TIMER_CALLBACK pfnti,
         PVOID pv,
         PTP_CALLBACK_ENVIRON pcbe
)  

Parameters

pfnti
Type: PTP_TIMER_CALLBACK 

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

pv
Type: PVOID 

[in, out, optional] Optional application-defined data to pass to the callback function.

pcbe
Type: PTP_CALLBACK_ENVIRON 

[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

Type: PTP_TIMER 

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.

Requirements

Header: Declared in threadpoolapiset.h.

Library: Use kernelx.lib.