WaitForSingleObjectEx 関数 (synchapi.h)

  • [アーティクル]

指定されたオブジェクトがシグナル状態になるまで待機し、I/O 完了ルーチンまたは非同期プロシージャ呼び出し (APC) がスレッドにキューに登録されるか、タイムアウト間隔が経過するまで待機します。

複数のオブジェクトを待機するには、 WaitForMultipleObjectsEx を使用します。

構文

DWORD WaitForSingleObjectEx(
  [in] HANDLE hHandle,
  [in] DWORD  dwMilliseconds,
  [in] BOOL   bAlertable
);

パラメーター

[in] hHandle

オブジェクトへのハンドル。 ハンドルを指定できるオブジェクトの種類の一覧については、次の「解説」セクションを参照してください。

待機がまだ保留中の間にこのハンドルが閉じられた場合、関数の動作は未定義です。

ハンドルには SYNCHRONIZE アクセス権が必要です。 詳細については、「 Standard Access Rights」を参照してください。

[in] dwMilliseconds

タイムアウト間隔 (ミリ秒単位)。 0 以外の値を指定した場合、関数は、オブジェクトが通知されるか、I/O 完了ルーチンまたは APC がキューに登録されるか、間隔が経過するまで待機します。 dwMilliseconds が 0 の場合、条件が満たされていない場合、関数は待機状態に入りません。常にすぐに返されます。 dwMilliseconds が INFINITE の場合、この関数は、オブジェクトが通知された場合、または I/O 完了ルーチンまたは APC がキューに入っている場合にのみを返します。

Windows XP、Windows Server 2003、Windows Vista、Windows 7、Windows Server 2008、Windows Server 2008 R2: dwMilliseconds 値には低電力状態で経過した時間も含まれます。 たとえば、コンピューターがスリープ状態の間もタイムアウトのカウント ダウンは継続されます。

Windows 8、Windows Server 2012、Windows 8.1、Windows Server 2012 R2、Windows 10、Windows Server 2016: dwMilliseconds 値には低電力状態で経過した時間は含まれません。 たとえば、コンピューターがスリープ状態の間、タイムアウトのカウント ダウンは継続されません。

[in] bAlertable

このパラメーターが TRUE で、スレッドが待機状態の場合、システムが I/O 完了ルーチンまたは APC をキューに入れ、スレッドがルーチンまたは関数を実行すると、 関数が戻ります。 それ以外の場合、関数は戻らず、完了ルーチンまたは APC 関数は実行されません。

完了ルーチンは、指定された ReadFileEx または WriteFileEx 関数が完了したときにキューに入れられます。 待機関数が戻り、完了ルーチンが呼び出されるのは 、bAlertable が TRUE で、呼び出し元のスレッドが読み取り操作または書き込み操作を開始したスレッドである場合のみです。 APC がキューに登録されるのは、QueueUserAPC を呼び出したときです。

戻り値

関数が成功した場合、戻り値は、関数が返される原因となったイベントを示します。 次のいずれかの値を指定できます。

リターン コード/値 Description
WAIT_ABANDONED
0x00000080L
 指定されたオブジェクトは、所有しているスレッドが終了する前にミューテックス オブジェクトを所有していたスレッドによって解放されなかったミューテックス オブジェクトです。 ミューテックス オブジェクトの所有権は呼び出し元のスレッドに付与され、ミューテックスは非署名に設定されます。

ミューテックスが永続的な状態情報を保護していた場合は、一貫性のためにチェックする必要があります。
WAIT_IO_COMPLETION
0x000000C0L
 待機は、スレッドにキューに登録された 1 つ以上のユーザー モード 非同期プロシージャ呼び出し (APC) によって終了しました。
WAIT_OBJECT_0
0x000000000L
 指定したオブジェクトの状態が通知されます。
WAIT_TIMEOUT
0x00000102L
 タイムアウト間隔が経過し、オブジェクトの状態が非割り当てです。
WAIT_FAILED
(DWORD)0xFFFFFFFF
 関数が失敗しました。 詳細なエラー情報を得るには、GetLastError を呼び出します。

解説

WaitForSingleObjectEx 関数は、待機条件が満たされているかどうかを判断します。 条件が満たされていない場合、呼び出し元のスレッドは、待機条件の条件が満たされるか、タイムアウト間隔が経過するまで待機状態になります。

関数は、一部の種類の同期オブジェクトの状態を変更します。 変更は、シグナル状態によって関数が返されたオブジェクトに対してのみ行われます。 たとえば、セマフォ オブジェクトの数は 1 ずつ減少します。

WaitForSingleObjectEx 関数は、次のオブジェクトを待機できます。

  • 変更通知
  • コンソール入力
  • イベント
  • メモリ リソース通知
  • Mutex
  • Process
  • Semaphore
  • スレッド
  • 待機可能タイマー
直接または間接的にウィンドウを作成する待機関数とコードを呼び出す場合は注意が必要です。 スレッドがウィンドウを作成する場合は、メッセージを処理する必要があります。 メッセージ ブロードキャストは、システム内のすべてのウィンドウに送信されます。 タイムアウト間隔のない待機関数を使用するスレッドによって、システムがデッドロックする可能性があります。 ウィンドウを間接的に作成するコードの例として、DDE と CoInitialize 関数の 2 つがあります。 したがって、ウィンドウを作成するスレッドがある場合は、WaitForSingleObjectEx ではなく、MsgWaitForMultipleObjects または MsgWaitForMultipleObjectsEx を使用します。

例

例については、「 完了ルーチンを使用した名前付きパイプ サーバー」を参照してください。

要件

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

関連項目

同期関数

待機関数