DeleteTimerQueueEx

The DeleteTimerQueueEx function deletes a timer queue. Any pending timers in the queue are canceled and deleted.

BOOL DeleteTimerQueueEx(
  HANDLE TimerQueue,      // handle to timer queue
  HANDLE CompletionEvent  // handle to completion event
);

Parameters

TimerQueue

[in] Handle to a timer queue. This handle is returned by the CreateTimerQueue function.

If the timer was created using the default timer queue, this parameter should be NULL.

CompletionEvent

[in] Specifies the event to be signaled when the function is successful and all callback functions have completed.

If this parameter is not INVALID_HANDLE_VALUE, the function is non-blocking; it does not wait for all callback functions to complete. Otherwise, the function returns immediately.

Return Values

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

Do not make blocking calls to DeleteTimerQueueEx from within a timer callback.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Unsupported.
  Header: Declared in Winbase.h; include Windows.h.
  Library: Use Kernel32.lib.

See Also

Synchronization Overview, Synchronization Functions, CreateTimerQueue, DeleteTimerQueueTimer, Thread Pooling