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

WaitOnAddress

関数
指定アドレスの値が変化するまでスレッドを待機させる。
DLLapi-ms-win-core-synch-l1-2-0.dll呼出規約winapiSetLastErrorあり対応OSwindows8.0

シグネチャ

// api-ms-win-core-synch-l1-2-0.dll
#include <windows.h>

BOOL WaitOnAddress(
    void* Address,
    void* CompareAddress,
    UINT_PTR AddressSize,
    DWORD dwMilliseconds   // optional
);

パラメーター

名前方向説明
Addressvoid*in待機対象のアドレス。Address の値が CompareAddress の値と異なる場合、関数はただちに戻ります。値が同じ場合、同一プロセス内の別スレッドが WakeByAddressSingle または WakeByAddressAll を呼び出して Address の値が変化したことを通知するか、タイムアウトが経過するか、いずれか早い方が発生するまで関数は戻りません。
CompareAddressvoid*inAddress で以前に観測された値の場所へのポインター。Address の値が CompareAddress の値と異なるようになった時点で関数は戻ります。
AddressSizeUINT_PTRin値のサイズ(バイト単位)。このパラメーターには 1248 のいずれかを指定できます。
dwMillisecondsDWORDinoptional操作がタイムアウトするまでに待機するミリ秒数。このパラメーターが INFINITE の場合、スレッドは無期限に待機します。

戻り値の型: BOOL

公式ドキュメント

指定したアドレスの値が変化するまで待機します。

戻り値

待機が成功した場合は TRUE。操作が失敗した場合、関数は FALSE を返します。待機が失敗した場合は GetLastError を呼び出して拡張エラー情報を取得します。特に、操作がタイムアウトした場合、GetLastErrorERROR_TIMEOUT を返します。

解説(Remarks)

Microsoft Store アプリの開発者は、Windows Software Development Kit (SDK) をインストールして synchronization.lib を入手する必要がある場合があります。

WaitOnAddress 関数は、特定の値が望ましくない値から他の任意の値へ変化するのをスレッドが待機するために使用できます。WaitOnAddresswhile ループ内で Sleep 関数を使用するよりも効率的です。これは WaitOnAddress がスレッドスケジューラーを妨げないためです。また WaitOnAddress はイベントオブジェクトを使用するよりも簡単です。イベントを作成して初期化し、値と正しく同期されていることを確認する必要がないためです。WaitOnAddress は、後述のようにスレッドを早期に起こす可能性がある点を除き、メモリ不足の状態の影響を受けません。

同一プロセス内で、スレッドが待機しているアドレスの値を変更するスレッドは、待機中の単一スレッドを起こすには WakeByAddressSingle を、待機中のすべてのスレッドを起こすには WakeByAddressAll を呼び出す必要があります。WakeByAddressSingle が呼び出された場合、他の待機中のスレッドは引き続き待機します。

注: WaitOnAddress はアドレスがシグナル状態になったときに戻ることが保証されていますが、それ以外の理由で戻ることも許容されています。このため、WaitOnAddress が戻った後、呼び出し元は新しい値を元の望ましくない値と比較し、値が実際に変化したことを確認する必要があります。たとえば、次のような状況ではスレッドが早期に起こされることがあります。
  • メモリ不足の状態
  • 同じアドレスに対する以前の起こし操作が破棄された場合
  • オペレーティングシステムのチェックビルドでコードを実行している場合

次の例は WaitOnAddress の使用方法を示しています。

ULONG g_TargetValue; // global, accessible to all threads
ULONG CapturedValue;
ULONG UndesiredValue;

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

各言語での呼び出し定義

// api-ms-win-core-synch-l1-2-0.dll
#include <windows.h>

BOOL WaitOnAddress(
    void* Address,
    void* CompareAddress,
    UINT_PTR AddressSize,
    DWORD dwMilliseconds   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("api-ms-win-core-synch-l1-2-0.dll", SetLastError = true, ExactSpelling = true)]
static extern bool WaitOnAddress(
    IntPtr Address,   // void*
    IntPtr CompareAddress,   // void*
    UIntPtr AddressSize,   // UINT_PTR
    uint dwMilliseconds   // DWORD optional
);
<DllImport("api-ms-win-core-synch-l1-2-0.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WaitOnAddress(
    Address As IntPtr,   ' void*
    CompareAddress As IntPtr,   ' void*
    AddressSize As UIntPtr,   ' UINT_PTR
    dwMilliseconds As UInteger   ' DWORD optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' Address : void*
' CompareAddress : void*
' AddressSize : UINT_PTR
' dwMilliseconds : DWORD optional
Declare PtrSafe Function WaitOnAddress Lib "api-ms-win-core-synch-l1-2-0" ( _
    ByVal Address As LongPtr, _
    ByVal CompareAddress As LongPtr, _
    ByVal AddressSize 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

WaitOnAddress = ctypes.windll.LoadLibrary("api-ms-win-core-synch-l1-2-0.dll").WaitOnAddress
WaitOnAddress.restype = wintypes.BOOL
WaitOnAddress.argtypes = [
    ctypes.POINTER(None),  # Address : void*
    ctypes.POINTER(None),  # CompareAddress : void*
    ctypes.c_size_t,  # AddressSize : UINT_PTR
    wintypes.DWORD,  # dwMilliseconds : DWORD optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('api-ms-win-core-synch-l1-2-0.dll')
WaitOnAddress = Fiddle::Function.new(
  lib['WaitOnAddress'],
  [
    Fiddle::TYPE_VOIDP,  # Address : void*
    Fiddle::TYPE_VOIDP,  # CompareAddress : void*
    Fiddle::TYPE_UINTPTR_T,  # AddressSize : UINT_PTR
    -Fiddle::TYPE_INT,  # dwMilliseconds : DWORD optional
  ],
  Fiddle::TYPE_INT)
#[link(name = "api-ms-win-core-synch-l1-2-0")]
extern "system" {
    fn WaitOnAddress(
        Address: *mut (),  // void*
        CompareAddress: *mut (),  // void*
        AddressSize: usize,  // UINT_PTR
        dwMilliseconds: u32  // DWORD optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("api-ms-win-core-synch-l1-2-0.dll", SetLastError = true)]
public static extern bool WaitOnAddress(IntPtr Address, IntPtr CompareAddress, UIntPtr AddressSize, uint dwMilliseconds);
"@
$api = Add-Type -MemberDefinition $sig -Name 'api-ms-win-core-synch-l1-2-0_WaitOnAddress' -Namespace Win32 -PassThru
# $api::WaitOnAddress(Address, CompareAddress, AddressSize, dwMilliseconds)
#uselib "api-ms-win-core-synch-l1-2-0.dll"
#func global WaitOnAddress "WaitOnAddress" sptr, sptr, sptr, sptr
; WaitOnAddress Address, CompareAddress, AddressSize, dwMilliseconds   ; 戻り値は stat
; Address : void* -> "sptr"
; CompareAddress : void* -> "sptr"
; AddressSize : UINT_PTR -> "sptr"
; dwMilliseconds : DWORD optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "api-ms-win-core-synch-l1-2-0.dll"
#cfunc global WaitOnAddress "WaitOnAddress" sptr, sptr, sptr, int
; res = WaitOnAddress(Address, CompareAddress, AddressSize, dwMilliseconds)
; Address : void* -> "sptr"
; CompareAddress : void* -> "sptr"
; AddressSize : UINT_PTR -> "sptr"
; dwMilliseconds : DWORD optional -> "int"
; BOOL WaitOnAddress(void* Address, void* CompareAddress, UINT_PTR AddressSize, DWORD dwMilliseconds)
#uselib "api-ms-win-core-synch-l1-2-0.dll"
#cfunc global WaitOnAddress "WaitOnAddress" intptr, intptr, intptr, int
; res = WaitOnAddress(Address, CompareAddress, AddressSize, dwMilliseconds)
; Address : void* -> "intptr"
; CompareAddress : void* -> "intptr"
; AddressSize : UINT_PTR -> "intptr"
; dwMilliseconds : DWORD optional -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	api_ms_win_core_synch_l1_2_0 = windows.NewLazySystemDLL("api-ms-win-core-synch-l1-2-0.dll")
	procWaitOnAddress = api_ms_win_core_synch_l1_2_0.NewProc("WaitOnAddress")
)

// Address (void*), CompareAddress (void*), AddressSize (UINT_PTR), dwMilliseconds (DWORD optional)
r1, _, err := procWaitOnAddress.Call(
	uintptr(Address),
	uintptr(CompareAddress),
	uintptr(AddressSize),
	uintptr(dwMilliseconds),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function WaitOnAddress(
  Address: Pointer;   // void*
  CompareAddress: Pointer;   // void*
  AddressSize: NativeUInt;   // UINT_PTR
  dwMilliseconds: DWORD   // DWORD optional
): BOOL; stdcall;
  external 'api-ms-win-core-synch-l1-2-0.dll' name 'WaitOnAddress';
result := DllCall("api-ms-win-core-synch-l1-2-0\WaitOnAddress"
    , "Ptr", Address   ; void*
    , "Ptr", CompareAddress   ; void*
    , "UPtr", AddressSize   ; UINT_PTR
    , "UInt", dwMilliseconds   ; DWORD optional
    , "Int")   ; return: BOOL
●WaitOnAddress(Address, CompareAddress, AddressSize, dwMilliseconds) = DLL("api-ms-win-core-synch-l1-2-0.dll", "bool WaitOnAddress(void*, void*, int, dword)")
# 呼び出し: WaitOnAddress(Address, CompareAddress, AddressSize, dwMilliseconds)
# Address : void* -> "void*"
# CompareAddress : void* -> "void*"
# AddressSize : UINT_PTR -> "int"
# dwMilliseconds : DWORD optional -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef WaitOnAddressNative = Int32 Function(Pointer<Void>, Pointer<Void>, UintPtr, Uint32);
typedef WaitOnAddressDart = int Function(Pointer<Void>, Pointer<Void>, int, int);
final WaitOnAddress = DynamicLibrary.open('api-ms-win-core-synch-l1-2-0.dll')
    .lookupFunction<WaitOnAddressNative, WaitOnAddressDart>('WaitOnAddress');
// Address : void* -> Pointer<Void>
// CompareAddress : void* -> Pointer<Void>
// AddressSize : UINT_PTR -> UintPtr
// dwMilliseconds : DWORD optional -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WaitOnAddress(
  Address: Pointer;   // void*
  CompareAddress: Pointer;   // void*
  AddressSize: NativeUInt;   // UINT_PTR
  dwMilliseconds: DWORD   // DWORD optional
): BOOL; stdcall;
  external 'api-ms-win-core-synch-l1-2-0.dll' name 'WaitOnAddress';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WaitOnAddress"
  c_WaitOnAddress :: Ptr () -> Ptr () -> CUIntPtr -> Word32 -> IO CInt
-- Address : void* -> Ptr ()
-- CompareAddress : void* -> Ptr ()
-- AddressSize : UINT_PTR -> CUIntPtr
-- dwMilliseconds : DWORD optional -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let waitonaddress =
  foreign "WaitOnAddress"
    ((ptr void) @-> (ptr void) @-> size_t @-> uint32_t @-> returning int32_t)
(* Address : void* -> (ptr void) *)
(* CompareAddress : void* -> (ptr void) *)
(* AddressSize : UINT_PTR -> size_t *)
(* dwMilliseconds : DWORD optional -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library api-ms-win-core-synch-l1-2-0 (t "api-ms-win-core-synch-l1-2-0.dll"))
(cffi:use-foreign-library api-ms-win-core-synch-l1-2-0)

(cffi:defcfun ("WaitOnAddress" wait-on-address :convention :stdcall) :int32
  (address :pointer)   ; void*
  (compare-address :pointer)   ; void*
  (address-size :uint64)   ; UINT_PTR
  (dw-milliseconds :uint32))   ; DWORD optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WaitOnAddress = Win32::API::More->new('api-ms-win-core-synch-l1-2-0',
    'BOOL WaitOnAddress(LPVOID Address, LPVOID CompareAddress, WPARAM AddressSize, DWORD dwMilliseconds)');
# my $ret = $WaitOnAddress->Call($Address, $CompareAddress, $AddressSize, $dwMilliseconds);
# Address : void* -> LPVOID
# CompareAddress : void* -> LPVOID
# AddressSize : UINT_PTR -> WPARAM
# dwMilliseconds : DWORD optional -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。