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

WaitForSingleObject

関数
指定オブジェクトがシグナル状態になるか時間切れまで待機する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

WAIT_EVENT WaitForSingleObject(
    HANDLE hHandle,
    DWORD dwMilliseconds
);

パラメーター

名前方向説明
hHandleHANDLEin

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

このハンドルが待機中に閉じられた場合、関数の動作は未定義となります。

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

dwMillisecondsDWORDin

タイムアウト間隔(ミリ秒単位)。0 以外の値を指定した場合、関数はオブジェクトがシグナル状態になるか、間隔が経過するまで待機します。dwMilliseconds が 0 の場合、オブジェクトがシグナル状態でなければ関数は待機状態に入らず、常に即座に戻ります。dwMillisecondsINFINITE の場合、関数はオブジェクトがシグナル状態になったときにのみ戻ります。

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

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

戻り値の型: WAIT_EVENT

公式ドキュメント

指定したオブジェクトがシグナル状態になるか、タイムアウト間隔が経過するまで待機します。

戻り値

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

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

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

WAIT_OBJECT_0
0x00000000L
指定したオブジェクトの状態がシグナル状態です。
WAIT_TIMEOUT
0x00000102L
タイムアウト間隔が経過し、オブジェクトの状態は非シグナル状態です。
WAIT_FAILED
(DWORD)0xFFFFFFFF
関数が失敗しました。拡張エラー情報を取得するには、 GetLastError を呼び出してください。

解説(Remarks)

WaitForSingleObject 関数は、指定したオブジェクトの現在の状態を確認します。オブジェクトの状態が非シグナル状態の場合、呼び出し側スレッドは、オブジェクトがシグナル状態になるか、タイムアウト間隔が経過するまで待機状態に入ります。

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

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

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

例については、 Using Mutex Objects を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 WaitForSingleObject(
    HANDLE hHandle,
    DWORD dwMilliseconds
);
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern uint WaitForSingleObject(
    IntPtr hHandle,   // HANDLE
    uint dwMilliseconds   // DWORD
);
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WaitForSingleObject(
    hHandle As IntPtr,   ' HANDLE
    dwMilliseconds As UInteger   ' DWORD
) As UInteger
End Function
' hHandle : HANDLE
' dwMilliseconds : DWORD
Declare PtrSafe Function WaitForSingleObject Lib "kernel32" ( _
    ByVal hHandle As LongPtr, _
    ByVal dwMilliseconds As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

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

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procWaitForSingleObject = kernel32.NewProc("WaitForSingleObject")
)

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

extern "kernel32" fn WaitForSingleObject(
    hHandle: ?*anyopaque, // HANDLE
    dwMilliseconds: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;
proc WaitForSingleObject(
    hHandle: pointer,  # HANDLE
    dwMilliseconds: uint32  # DWORD
): uint32 {.importc: "WaitForSingleObject", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
uint WaitForSingleObject(
    void* hHandle,   // HANDLE
    uint dwMilliseconds   // DWORD
);
ccall((:WaitForSingleObject, "KERNEL32.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, UInt32),
      hHandle, dwMilliseconds)
# hHandle : HANDLE -> Ptr{Cvoid}
# dwMilliseconds : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t WaitForSingleObject(
    void* hHandle,
    uint32_t dwMilliseconds);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.WaitForSingleObject(hHandle, dwMilliseconds)
-- hHandle : HANDLE
-- dwMilliseconds : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const WaitForSingleObject = lib.func('__stdcall', 'WaitForSingleObject', 'uint32_t', ['void *', 'uint32_t']);
// WaitForSingleObject(hHandle, dwMilliseconds)
// hHandle : HANDLE -> 'void *'
// dwMilliseconds : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  WaitForSingleObject: { parameters: ["pointer", "u32"], result: "u32" },
});
// lib.symbols.WaitForSingleObject(hHandle, dwMilliseconds)
// hHandle : HANDLE -> "pointer"
// dwMilliseconds : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t WaitForSingleObject(
    void* hHandle,
    uint32_t dwMilliseconds);
C, "KERNEL32.dll");
// $ffi->WaitForSingleObject(hHandle, dwMilliseconds);
// hHandle : HANDLE
// dwMilliseconds : DWORD
// 構造体/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 WaitForSingleObject(
        Pointer hHandle,   // HANDLE
        int dwMilliseconds   // DWORD
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun WaitForSingleObject = WaitForSingleObject(
    hHandle : Void*,   # HANDLE
    dwMilliseconds : UInt32   # DWORD
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

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

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

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

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

関連項目

類似 API
使用する型