Share via

UnregisterWait 関数 (winbase.h)

  • [アーティクル]

RegisterWaitForSingleObject 関数によって発行された登録済み待機操作を取り消します。

完了イベントを使用するには、 UnregisterWaitEx 関数を呼び出します。

構文

BOOL UnregisterWait(
  [in] HANDLE WaitHandle
);

パラメーター

[in] WaitHandle

待機ハンドル。 このハンドルは RegisterWaitForSingleObject 関数によって返されます。

戻り値

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

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

解説

UnregisterWait が呼び出されたときにタイマーに関連付けられているコールバック関数が完了していない場合、UnregisterWait はコールバック関数の待機を登録解除し、ERROR_IO_PENDINGエラー コードで失敗します。 エラー コードは、関数が失敗したことを示すものではありません。また、関数を再度呼び出す必要はありません。 登録解除操作が失敗した場合にのみ、コードでエラー コードを設定する必要がある場合は、代わりに UnregisterWaitEx を呼び出します。

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

要件

要件 値
サポートされている最小のクライアント Windows XP (デスクトップ アプリのみ)
サポートされている最小のサーバー Windows Server 2003 (デスクトップ アプリのみ)
対象プラットフォーム Windows
ヘッダー winbase.h (Windows.h を含む)
Library Kernel32.lib
[DLL] Kernel32.dll

関連項目

RegisterWaitForSingleObject

同期関数

スレッド プール

UnregisterWaitEx