CreateTimerQueue function (Windows)

Switch View :
ScriptFree
CreateTimerQueue function

Creates a queue for timers. Timer-queue timers are lightweight objects that enable you to specify a callback function to be called at a specified time.

Syntax

HANDLE WINAPI CreateTimerQueue(void);

Parameters

This function has no parameters.

Return value

If the function succeeds, the return value is a handle to the timer queue. This handle can be used only in functions that require a handle to a timer queue.

If the function fails, the return value is NULL. To get extended error information, call GetLastError.

Remarks

To add a timer to the queue, call the CreateTimerQueueTimer function. To remove a timer from the queue, call the DeleteTimerQueueTimer function.

When you are finished with the queue of timers, call the DeleteTimerQueueEx function to delete the timer queue. Any pending timers in the queue are canceled and deleted.

To compile an application that uses this function, define _WIN32_WINNT as 0x0500 or later. For more information, see Using the Windows Headers.

Examples

For an example that uses CreateTimerQueue, see Using Timer Queues.

Requirements

Minimum supported client

Windows 2000 Professional

Minimum supported server

Windows 2000 Server

Header

Winbase.h (include Windows.h)

Library

Kernel32.lib

DLL

Kernel32.dll

See also

CreateTimerQueueTimer
DeleteTimerQueueEx
DeleteTimerQueueTimer
Synchronization Functions
Thread Pooling
Timer Queues

 

 

Send comments about this topic to Microsoft

Build date: 9/7/2011