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

RegisterWaitForSingleObject

関数
オブジェクトのシグナル時にコールバックを呼ぶ待機を登録する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL RegisterWaitForSingleObject(
    HANDLE* phNewWaitObject,
    HANDLE hObject,
    WAITORTIMERCALLBACK Callback,
    void* Context,   // optional
    DWORD dwMilliseconds,
    WORKER_THREAD_FLAGS dwFlags
);

パラメーター

名前方向
phNewWaitObjectHANDLE*out
hObjectHANDLEin
CallbackWAITORTIMERCALLBACKin
Contextvoid*inoptional
dwMillisecondsDWORDin
dwFlagsWORKER_THREAD_FLAGSin

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL RegisterWaitForSingleObject(
    HANDLE* phNewWaitObject,
    HANDLE hObject,
    WAITORTIMERCALLBACK Callback,
    void* Context,   // optional
    DWORD dwMilliseconds,
    WORKER_THREAD_FLAGS dwFlags
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool RegisterWaitForSingleObject(
    IntPtr phNewWaitObject,   // HANDLE* out
    IntPtr hObject,   // HANDLE
    IntPtr Callback,   // WAITORTIMERCALLBACK
    IntPtr Context,   // void* optional
    uint dwMilliseconds,   // DWORD
    uint dwFlags   // WORKER_THREAD_FLAGS
);
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function RegisterWaitForSingleObject(
    phNewWaitObject As IntPtr,   ' HANDLE* out
    hObject As IntPtr,   ' HANDLE
    Callback As IntPtr,   ' WAITORTIMERCALLBACK
    Context As IntPtr,   ' void* optional
    dwMilliseconds As UInteger,   ' DWORD
    dwFlags As UInteger   ' WORKER_THREAD_FLAGS
) As Boolean
End Function
' phNewWaitObject : HANDLE* out
' hObject : HANDLE
' Callback : WAITORTIMERCALLBACK
' Context : void* optional
' dwMilliseconds : DWORD
' dwFlags : WORKER_THREAD_FLAGS
Declare PtrSafe Function RegisterWaitForSingleObject Lib "kernel32" ( _
    ByVal phNewWaitObject As LongPtr, _
    ByVal hObject As LongPtr, _
    ByVal Callback As LongPtr, _
    ByVal Context As LongPtr, _
    ByVal dwMilliseconds As Long, _
    ByVal dwFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

RegisterWaitForSingleObject = ctypes.windll.kernel32.RegisterWaitForSingleObject
RegisterWaitForSingleObject.restype = wintypes.BOOL
RegisterWaitForSingleObject.argtypes = [
    ctypes.c_void_p,  # phNewWaitObject : HANDLE* out
    wintypes.HANDLE,  # hObject : HANDLE
    ctypes.c_void_p,  # Callback : WAITORTIMERCALLBACK
    ctypes.POINTER(None),  # Context : void* optional
    wintypes.DWORD,  # dwMilliseconds : DWORD
    wintypes.DWORD,  # dwFlags : WORKER_THREAD_FLAGS
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procRegisterWaitForSingleObject = kernel32.NewProc("RegisterWaitForSingleObject")
)

// phNewWaitObject (HANDLE* out), hObject (HANDLE), Callback (WAITORTIMERCALLBACK), Context (void* optional), dwMilliseconds (DWORD), dwFlags (WORKER_THREAD_FLAGS)
r1, _, err := procRegisterWaitForSingleObject.Call(
	uintptr(phNewWaitObject),
	uintptr(hObject),
	uintptr(Callback),
	uintptr(Context),
	uintptr(dwMilliseconds),
	uintptr(dwFlags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function RegisterWaitForSingleObject(
  phNewWaitObject: Pointer;   // HANDLE* out
  hObject: THandle;   // HANDLE
  Callback: Pointer;   // WAITORTIMERCALLBACK
  Context: Pointer;   // void* optional
  dwMilliseconds: DWORD;   // DWORD
  dwFlags: DWORD   // WORKER_THREAD_FLAGS
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'RegisterWaitForSingleObject';
result := DllCall("KERNEL32\RegisterWaitForSingleObject"
    , "Ptr", phNewWaitObject   ; HANDLE* out
    , "Ptr", hObject   ; HANDLE
    , "Ptr", Callback   ; WAITORTIMERCALLBACK
    , "Ptr", Context   ; void* optional
    , "UInt", dwMilliseconds   ; DWORD
    , "UInt", dwFlags   ; WORKER_THREAD_FLAGS
    , "Int")   ; return: BOOL
●RegisterWaitForSingleObject(phNewWaitObject, hObject, Callback, Context, dwMilliseconds, dwFlags) = DLL("KERNEL32.dll", "bool RegisterWaitForSingleObject(void*, void*, void*, void*, dword, dword)")
# 呼び出し: RegisterWaitForSingleObject(phNewWaitObject, hObject, Callback, Context, dwMilliseconds, dwFlags)
# phNewWaitObject : HANDLE* out -> "void*"
# hObject : HANDLE -> "void*"
# Callback : WAITORTIMERCALLBACK -> "void*"
# Context : void* optional -> "void*"
# dwMilliseconds : DWORD -> "dword"
# dwFlags : WORKER_THREAD_FLAGS -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。