DeleteTimerQueueEx 関数 (threadpoollegacyapiset.h)

タイマーキューを削除します。キュー内の保留中のタイマーはすべて取り消され、削除されます。

構文

BOOL DeleteTimerQueueEx(
  [in]           HANDLE TimerQueue,
  [in, optional] HANDLE CompletionEvent
);

[in] TimerQueue

タイマーキューへのハンドル。このハンドルは、 CreateTimerQueue 関数によって返されます。

[in, optional] CompletionEvent

関数が成功し、すべてのコールバック関数が完了したときに通知されるイベントオブジェクトへのハンドル。このパラメーターは、NULL でもかまいません。

このパラメーターが INVALID_HANDLE_VALUEの場合、関数はすべてのコールバック関数が完了するまで待機してから、を返します。

このパラメーターが NULL の場合、関数はタイマーに削除のマークを付け、直ちにを返します。ただし、ほとんどの呼び出し元は、必要なクリーンアップを実行できるように、コールバック関数が完了するまで待機する必要があります。

関数が成功すると、戻り値は 0 以外になります。

関数が失敗した場合は、0 を返します。詳細なエラー情報を得るには、GetLastError を呼び出します。

タイマーコールバック内から DeleteTimerQueueEx へのブロッキング呼び出しを行わないでください。

この関数を使用するアプリケーションをコンパイルするには、 _WIN32_WINNT を 0x0500 以降として定義します。詳細については、「 Windows ヘッダーの使用」を参照してください。