CloseThreadpoolWait 関数 (threadpoolapiset.h)

指定した待機オブジェクトを解放します。

構文

void CloseThreadpoolWait(
  [in, out] PTP_WAIT pwa
);

パラメーター

[in, out] pwa

待機オブジェクトを定義する TP_WAIT 構造体へのポインター。 CreateThreadpoolWait 関数は、このポインターを返します。

戻り値

なし

解説

未処理のコールバックがない場合、待機オブジェクトはすぐに解放されます。それ以外の場合、タイマー オブジェクトは、未処理のコールバックが完了した後に非同期的に解放されます。

場合によっては、 CloseThreadpoolWait が呼び出された後にコールバック関数が実行されることがあります。 この動作を防ぐには:

• h パラメーターを NULL に設定して、SetThreadpoolWait 関数または SetThreadpoolWaitEx 関数を呼び出します。
• fCancelPendingCallbacks パラメーターを TRUE に設定して WaitForThreadpoolWaitCallbacks 関数を呼び出します。
• CloseThreadpoolWait を呼び出します。

wait オブジェクトに関連付けられているクリーンアップ グループがある場合は、この関数を呼び出す必要はありません。 CloseThreadpoolCleanupGroupMembers 関数を呼び出すと、クリーンアップ グループに関連付けられている作業オブジェクト、待機オブジェクト、およびタイマー オブジェクトが解放されます。

この関数を使用するアプリケーションをコンパイルするには、_WIN32_WINNTを 0x0600 以上として定義します。

例

例については、「 スレッド プール関数の使用」を参照してください。

要件

関連項目

CreateThreadpoolWait

SetThreadpoolWait

SetThreadpoolWaitEx

スレッド プール

WaitForThreadpoolWaitCallbacks