Win32 API 日本語リファレンス
ホームSystem.Threading › WaitForSingleObjectEx

WaitForSingleObjectEx

関数
警告可能モードで単一オブジェクトのシグナルを待機する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// KERNEL32.dll
#include <windows.h>

WAIT_EVENT WaitForSingleObjectEx(
    HANDLE hHandle,
    DWORD dwMilliseconds,
    BOOL bAlertable
);

パラメーター

名前方向説明
hHandleHANDLEin

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

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

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

dwMillisecondsDWORDin

タイムアウト間隔 (ミリ秒単位)。0 以外の値を指定した場合、関数はオブジェクトがシグナル状態になるか、I/O 完了ルーチンまたは APC がキューイングされるか、または間隔が経過するまで待機します。dwMilliseconds が 0 の場合、条件が満たされていなくても関数は待機状態に入らず、常にただちに返ります。dwMillisecondsINFINITE の場合、オブジェクトがシグナル状態になるか、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 以降: dwMilliseconds の値には、低電力状態で費やされた時間は含まれません。たとえば、コンピューターがスリープ状態の間はタイムアウトのカウントダウンは継続しません。

bAlertableBOOLin

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

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

戻り値の型: WAIT_EVENT

公式ドキュメント

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

戻り値

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

戻りコード/値 説明
WAIT_ABANDONED
0x00000080L
指定されたオブジェクトは、それを所有していたスレッドが終了する前に解放されなかったミューテックス オブジェクトです。ミューテックス オブジェクトの所有権は呼び出し元スレッドに付与され、ミューテックスは非シグナル状態に設定されます。

ミューテックスが永続的な状態情報を保護していた場合は、その整合性を確認する必要があります。

WAIT_IO_COMPLETION
0x000000C0L
スレッドにキューイングされた 1 つ以上のユーザー モードの 非同期プロシージャ コール (APC) によって待機が終了しました。
WAIT_OBJECT_0
0x00000000L
指定されたオブジェクトの状態がシグナル状態です。
WAIT_TIMEOUT
0x00000102L
タイムアウト間隔が経過し、オブジェクトの状態が非シグナル状態です。
WAIT_FAILED
(DWORD)0xFFFFFFFF
関数が失敗しました。拡張エラー情報を取得するには、 GetLastError を呼び出してください。

解説(Remarks)

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

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

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

待機関数と、直接または間接的にウィンドウを作成するコードを呼び出す際には注意してください。スレッドがウィンドウを作成する場合、そのスレッドはメッセージを処理する必要があります。メッセージのブロードキャストはシステム内のすべてのウィンドウに送信されます。タイムアウト間隔なしで待機関数を使用するスレッドは、システムをデッドロック状態にする可能性があります。間接的にウィンドウを作成するコードの例としては、DDE と CoInitialize 関数の 2 つが挙げられます。したがって、ウィンドウを作成するスレッドがある場合は、 WaitForSingleObjectEx ではなく MsgWaitForMultipleObjects または MsgWaitForMultipleObjectsEx を使用してください。

例については、 Named Pipe Server Using Completion Routines を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// KERNEL32.dll
#include <windows.h>

WAIT_EVENT WaitForSingleObjectEx(
    HANDLE hHandle,
    DWORD dwMilliseconds,
    BOOL bAlertable
);
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern uint WaitForSingleObjectEx(
    IntPtr hHandle,   // HANDLE
    uint dwMilliseconds,   // DWORD
    bool bAlertable   // BOOL
);
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WaitForSingleObjectEx(
    hHandle As IntPtr,   ' HANDLE
    dwMilliseconds As UInteger,   ' DWORD
    bAlertable As Boolean   ' BOOL
) As UInteger
End Function
' hHandle : HANDLE
' dwMilliseconds : DWORD
' bAlertable : BOOL
Declare PtrSafe Function WaitForSingleObjectEx Lib "kernel32" ( _
    ByVal hHandle As LongPtr, _
    ByVal dwMilliseconds As Long, _
    ByVal bAlertable As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WaitForSingleObjectEx = ctypes.windll.kernel32.WaitForSingleObjectEx
WaitForSingleObjectEx.restype = wintypes.DWORD
WaitForSingleObjectEx.argtypes = [
    wintypes.HANDLE,  # hHandle : HANDLE
    wintypes.DWORD,  # dwMilliseconds : DWORD
    wintypes.BOOL,  # bAlertable : BOOL
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
WaitForSingleObjectEx = Fiddle::Function.new(
  lib['WaitForSingleObjectEx'],
  [
    Fiddle::TYPE_VOIDP,  # hHandle : HANDLE
    -Fiddle::TYPE_INT,  # dwMilliseconds : DWORD
    Fiddle::TYPE_INT,  # bAlertable : BOOL
  ],
  -Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn WaitForSingleObjectEx(
        hHandle: *mut core::ffi::c_void,  // HANDLE
        dwMilliseconds: u32,  // DWORD
        bAlertable: i32  // BOOL
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern uint WaitForSingleObjectEx(IntPtr hHandle, uint dwMilliseconds, bool bAlertable);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_WaitForSingleObjectEx' -Namespace Win32 -PassThru
# $api::WaitForSingleObjectEx(hHandle, dwMilliseconds, bAlertable)
#uselib "KERNEL32.dll"
#func global WaitForSingleObjectEx "WaitForSingleObjectEx" sptr, sptr, sptr
; WaitForSingleObjectEx hHandle, dwMilliseconds, bAlertable   ; 戻り値は stat
; hHandle : HANDLE -> "sptr"
; dwMilliseconds : DWORD -> "sptr"
; bAlertable : BOOL -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global WaitForSingleObjectEx "WaitForSingleObjectEx" sptr, int, int
; res = WaitForSingleObjectEx(hHandle, dwMilliseconds, bAlertable)
; hHandle : HANDLE -> "sptr"
; dwMilliseconds : DWORD -> "int"
; bAlertable : BOOL -> "int"
; WAIT_EVENT WaitForSingleObjectEx(HANDLE hHandle, DWORD dwMilliseconds, BOOL bAlertable)
#uselib "KERNEL32.dll"
#cfunc global WaitForSingleObjectEx "WaitForSingleObjectEx" intptr, int, int
; res = WaitForSingleObjectEx(hHandle, dwMilliseconds, bAlertable)
; hHandle : HANDLE -> "intptr"
; dwMilliseconds : DWORD -> "int"
; bAlertable : BOOL -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procWaitForSingleObjectEx = kernel32.NewProc("WaitForSingleObjectEx")
)

// hHandle (HANDLE), dwMilliseconds (DWORD), bAlertable (BOOL)
r1, _, err := procWaitForSingleObjectEx.Call(
	uintptr(hHandle),
	uintptr(dwMilliseconds),
	uintptr(bAlertable),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // WAIT_EVENT
function WaitForSingleObjectEx(
  hHandle: THandle;   // HANDLE
  dwMilliseconds: DWORD;   // DWORD
  bAlertable: BOOL   // BOOL
): DWORD; stdcall;
  external 'KERNEL32.dll' name 'WaitForSingleObjectEx';
result := DllCall("KERNEL32\WaitForSingleObjectEx"
    , "Ptr", hHandle   ; HANDLE
    , "UInt", dwMilliseconds   ; DWORD
    , "Int", bAlertable   ; BOOL
    , "UInt")   ; return: WAIT_EVENT
●WaitForSingleObjectEx(hHandle, dwMilliseconds, bAlertable) = DLL("KERNEL32.dll", "dword WaitForSingleObjectEx(void*, dword, bool)")
# 呼び出し: WaitForSingleObjectEx(hHandle, dwMilliseconds, bAlertable)
# hHandle : HANDLE -> "void*"
# dwMilliseconds : DWORD -> "dword"
# bAlertable : BOOL -> "bool"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "kernel32" fn WaitForSingleObjectEx(
    hHandle: ?*anyopaque, // HANDLE
    dwMilliseconds: u32, // DWORD
    bAlertable: i32 // BOOL
) callconv(std.os.windows.WINAPI) u32;
proc WaitForSingleObjectEx(
    hHandle: pointer,  # HANDLE
    dwMilliseconds: uint32,  # DWORD
    bAlertable: int32  # BOOL
): uint32 {.importc: "WaitForSingleObjectEx", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
uint WaitForSingleObjectEx(
    void* hHandle,   // HANDLE
    uint dwMilliseconds,   // DWORD
    int bAlertable   // BOOL
);
ccall((:WaitForSingleObjectEx, "KERNEL32.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, UInt32, Int32),
      hHandle, dwMilliseconds, bAlertable)
# hHandle : HANDLE -> Ptr{Cvoid}
# dwMilliseconds : DWORD -> UInt32
# bAlertable : BOOL -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t WaitForSingleObjectEx(
    void* hHandle,
    uint32_t dwMilliseconds,
    int32_t bAlertable);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.WaitForSingleObjectEx(hHandle, dwMilliseconds, bAlertable)
-- hHandle : HANDLE
-- dwMilliseconds : DWORD
-- bAlertable : BOOL
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const WaitForSingleObjectEx = lib.func('__stdcall', 'WaitForSingleObjectEx', 'uint32_t', ['void *', 'uint32_t', 'int32_t']);
// WaitForSingleObjectEx(hHandle, dwMilliseconds, bAlertable)
// hHandle : HANDLE -> 'void *'
// dwMilliseconds : DWORD -> 'uint32_t'
// bAlertable : BOOL -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  WaitForSingleObjectEx: { parameters: ["pointer", "u32", "i32"], result: "u32" },
});
// lib.symbols.WaitForSingleObjectEx(hHandle, dwMilliseconds, bAlertable)
// hHandle : HANDLE -> "pointer"
// dwMilliseconds : DWORD -> "u32"
// bAlertable : BOOL -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t WaitForSingleObjectEx(
    void* hHandle,
    uint32_t dwMilliseconds,
    int32_t bAlertable);
C, "KERNEL32.dll");
// $ffi->WaitForSingleObjectEx(hHandle, dwMilliseconds, bAlertable);
// hHandle : HANDLE
// dwMilliseconds : DWORD
// bAlertable : BOOL
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Kernel32 extends StdCallLibrary {
    Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class);
    int WaitForSingleObjectEx(
        Pointer hHandle,   // HANDLE
        int dwMilliseconds,   // DWORD
        boolean bAlertable   // BOOL
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun WaitForSingleObjectEx = WaitForSingleObjectEx(
    hHandle : Void*,   # HANDLE
    dwMilliseconds : UInt32,   # DWORD
    bAlertable : Int32   # BOOL
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef WaitForSingleObjectExNative = Uint32 Function(Pointer<Void>, Uint32, Int32);
typedef WaitForSingleObjectExDart = int Function(Pointer<Void>, int, int);
final WaitForSingleObjectEx = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<WaitForSingleObjectExNative, WaitForSingleObjectExDart>('WaitForSingleObjectEx');
// hHandle : HANDLE -> Pointer<Void>
// dwMilliseconds : DWORD -> Uint32
// bAlertable : BOOL -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WaitForSingleObjectEx(
  hHandle: THandle;   // HANDLE
  dwMilliseconds: DWORD;   // DWORD
  bAlertable: BOOL   // BOOL
): DWORD; stdcall;
  external 'KERNEL32.dll' name 'WaitForSingleObjectEx';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WaitForSingleObjectEx"
  c_WaitForSingleObjectEx :: Ptr () -> Word32 -> CInt -> IO Word32
-- hHandle : HANDLE -> Ptr ()
-- dwMilliseconds : DWORD -> Word32
-- bAlertable : BOOL -> CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let waitforsingleobjectex =
  foreign "WaitForSingleObjectEx"
    ((ptr void) @-> uint32_t @-> int32_t @-> returning uint32_t)
(* hHandle : HANDLE -> (ptr void) *)
(* dwMilliseconds : DWORD -> uint32_t *)
(* bAlertable : BOOL -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("WaitForSingleObjectEx" wait-for-single-object-ex :convention :stdcall) :uint32
  (h-handle :pointer)   ; HANDLE
  (dw-milliseconds :uint32)   ; DWORD
  (b-alertable :int32))   ; BOOL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WaitForSingleObjectEx = Win32::API::More->new('KERNEL32',
    'DWORD WaitForSingleObjectEx(HANDLE hHandle, DWORD dwMilliseconds, BOOL bAlertable)');
# my $ret = $WaitForSingleObjectEx->Call($hHandle, $dwMilliseconds, $bAlertable);
# hHandle : HANDLE -> HANDLE
# dwMilliseconds : DWORD -> DWORD
# bAlertable : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API
使用する型