Expand Minimize

DeleteTimerQueue function

Deletes a timer queue. Any pending timers in the queue are canceled and deleted.

Note  This function is obsolete and has been replaced by the DeleteTimerQueueEx function.

Syntax


BOOL WINAPI DeleteTimerQueue(
  _In_  HANDLE TimerQueue
);

Parameters

TimerQueue [in]

A handle to the timer queue. This handle is returned by the CreateTimerQueue function.

Return value

If the function succeeds, the return value is nonzero.

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

Remarks

DeleteTimerQueue does not wait for all callback functions associated with the timer to complete.

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 DeleteTimerQueue, see Using Timer Queues.

Requirements

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

WinBase.h (include Windows.h)

Library

Kernel32.lib

DLL

Kernel32.dll

See also

CreateTimerQueue
DeleteTimerQueueEx
DeleteTimerQueueTimer
Synchronization Functions
Thread Pooling
Timer Queues

 

 

Community Additions

ADD
Show:
© 2014 Microsoft