SignalObjectAndWait
関数シグネチャ
// KERNEL32.dll
#include <windows.h>
WAIT_EVENT SignalObjectAndWait(
HANDLE hObjectToSignal,
HANDLE hObjectToWaitOn,
DWORD dwMilliseconds,
BOOL bAlertable
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hObjectToSignal | HANDLE | in | シグナル状態にするオブジェクトへのハンドル。このオブジェクトはセマフォ、ミューテックス、またはイベントのいずれかです。 ハンドルがセマフォの場合、SEMAPHORE_MODIFY_STATE アクセス権が必要です。ハンドルがイベントの場合、EVENT_MODIFY_STATE アクセス権が必要です。ハンドルがミューテックスで、かつ呼び出し元がそのミューテックスを所有していない場合、関数は ERROR_NOT_OWNER で失敗します。 |
| hObjectToWaitOn | HANDLE | in | 待機するオブジェクトへのハンドル。SYNCHRONIZE アクセス権が必要です。詳細については、 Synchronization Object Security and Access Rights を参照してください。ハンドルを指定できるオブジェクトの種類の一覧については、「解説」セクションを参照してください。 |
| dwMilliseconds | DWORD | in | タイムアウト間隔(ミリ秒単位)。この間隔が経過すると、オブジェクトが非シグナル状態であり、完了オブジェクトまたは非同期プロシージャ呼び出し (APC) オブジェクトがキューに入っていなくても、関数は戻ります。dwMilliseconds が 0 の場合、関数はオブジェクトの状態をテストし、キューに入っている完了ルーチンまたは APC を確認して、即座に戻ります。dwMilliseconds が INFINITE の場合、関数のタイムアウト間隔は経過しません。 |
| bAlertable | BOOL | in | このパラメーターが TRUE の場合、システムが I/O 完了ルーチンまたは APC 関数をキューに入れ、スレッドがその関数を呼び出すときに、関数は戻ります。FALSE の場合、関数は戻らず、スレッドは完了ルーチンまたは APC 関数を呼び出しません。 完了ルーチンは、APC をキューに入れた関数呼び出しが完了したときにキューに入れられます。この関数が戻り、完了ルーチンが呼び出されるのは、bAlertable が TRUE であり、かつ呼び出し元スレッドが APC をキューに入れたスレッドである場合のみです。 |
戻り値の型: WAIT_EVENT
公式ドキュメント
1 つのオブジェクトをシグナル状態にし、別のオブジェクトを待機する処理を単一の操作として実行します。
戻り値
関数が成功した場合、戻り値は関数が戻る原因となったイベントを示します。次のいずれかの値になります。
| 戻り値/値 | 説明 |
|---|---|
|
指定したオブジェクトはミューテックスオブジェクトであり、そのミューテックスを所有していたスレッドが終了する前にミューテックスを解放しませんでした。ミューテックスオブジェクトの所有権は呼び出し元スレッドに付与され、ミューテックスは非シグナル状態に設定されます。
ミューテックスが永続的な状態情報を保護していた場合は、その整合性を確認する必要があります。 |
|
待機は、スレッドにキューイングされた 1 つ以上のユーザーモードの 非同期プロシージャ呼び出し (APC) によって終了しました。 |
|
指定したオブジェクトの状態がシグナル状態です。 |
|
タイムアウト間隔が経過し、オブジェクトの状態は非シグナル状態です。 |
|
関数は失敗しました。拡張エラー情報を取得するには、 GetLastError を呼び出してください。 |
解説(Remarks)
SignalObjectAndWait 関数は、SetEvent の後に WaitForSingleObject を呼び出すといった個別の関数呼び出しと比較して、1 つのオブジェクトをシグナル状態にしてから別のオブジェクトを待機するより効率的な方法を提供します。
SignalObjectAndWait 関数は、次のオブジェクトを待機できます。
- 変更通知
- コンソール入力
- イベント
- メモリリソース通知
- ミューテックス
- プロセス
- セマフォ
- スレッド
- 待機可能タイマー
スレッドは SignalObjectAndWait 関数を使用して、オブジェクトをシグナル状態にする前にワーカースレッドが待機状態にあることを保証できます。たとえば、あるスレッドとワーカースレッドがイベントオブジェクトへのハンドルを使用して作業を同期する場合があります。スレッドは次のようなコードを実行します。
dwRet = WaitForSingleObject(hEventWorkerDone, INFINITE);
if( WAIT_OBJECT_0 == dwRet)
SetEvent(hEventMoreWorkToDo);
ワーカースレッドは次のようなコードを実行します。
dwRet = SignalObjectAndWait(hEventWorkerDone,
hEventMoreWorkToDo,
INFINITE,
FALSE);
「シグナル」と「待機」がアトミックな操作として実行される保証はないことに注意してください。他のプロセッサで実行されているスレッドは、SignalObjectAndWait を呼び出したスレッドが 2 番目のオブジェクトの待機を開始する前に、最初のオブジェクトのシグナル状態を観測する可能性があります。
Windows 7 で SignalObjectAndWait と PulseEvent を使用する場合は、複数のスレッド間でこれらの API を使用するとアプリケーションがデッドロックする可能性があるため、細心の注意を払ってください。SignalObjectAndWait によってシグナル状態にされたスレッドは、PulseEvent を呼び出して SignalObjectAndWait 呼び出しの待機オブジェクトをシグナル状態にします。状況によっては、SignalObjectAndWait の呼び出し元が待機オブジェクトのシグナル状態を間に合うように受け取れず、デッドロックを引き起こすことがあります。
待機関数と、直接的または間接的にウィンドウを作成するコードを使用する場合は注意してください。スレッドがウィンドウを作成する場合、そのスレッドはメッセージを処理する必要があります。メッセージブロードキャストはシステム内のすべてのウィンドウに送信されます。タイムアウト間隔なしで待機関数を使用するスレッドは、システムをデッドロックさせる可能性があります。間接的にウィンドウを作成するコードの例としては、DDE や COM の CoInitialize が挙げられます。したがって、ウィンドウを作成するスレッドがある場合は、SignalObjectAndWait を別のスレッドから呼び出すようにしてください。これが不可能な場合は、 MsgWaitForMultipleObjects または MsgWaitForMultipleObjectsEx を使用できますが、機能は同等ではありません。
この関数を使用するアプリケーションをコンパイルするには、_WIN32_WINNT を 0x0400 以降として定義してください。詳細については、 Using the Windows Headers を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// KERNEL32.dll
#include <windows.h>
WAIT_EVENT SignalObjectAndWait(
HANDLE hObjectToSignal,
HANDLE hObjectToWaitOn,
DWORD dwMilliseconds,
BOOL bAlertable
);[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern uint SignalObjectAndWait(
IntPtr hObjectToSignal, // HANDLE
IntPtr hObjectToWaitOn, // HANDLE
uint dwMilliseconds, // DWORD
bool bAlertable // BOOL
);<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SignalObjectAndWait(
hObjectToSignal As IntPtr, ' HANDLE
hObjectToWaitOn As IntPtr, ' HANDLE
dwMilliseconds As UInteger, ' DWORD
bAlertable As Boolean ' BOOL
) As UInteger
End Function' hObjectToSignal : HANDLE
' hObjectToWaitOn : HANDLE
' dwMilliseconds : DWORD
' bAlertable : BOOL
Declare PtrSafe Function SignalObjectAndWait Lib "kernel32" ( _
ByVal hObjectToSignal As LongPtr, _
ByVal hObjectToWaitOn 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
SignalObjectAndWait = ctypes.windll.kernel32.SignalObjectAndWait
SignalObjectAndWait.restype = wintypes.DWORD
SignalObjectAndWait.argtypes = [
wintypes.HANDLE, # hObjectToSignal : HANDLE
wintypes.HANDLE, # hObjectToWaitOn : 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')
SignalObjectAndWait = Fiddle::Function.new(
lib['SignalObjectAndWait'],
[
Fiddle::TYPE_VOIDP, # hObjectToSignal : HANDLE
Fiddle::TYPE_VOIDP, # hObjectToWaitOn : HANDLE
-Fiddle::TYPE_INT, # dwMilliseconds : DWORD
Fiddle::TYPE_INT, # bAlertable : BOOL
],
-Fiddle::TYPE_INT)#[link(name = "kernel32")]
extern "system" {
fn SignalObjectAndWait(
hObjectToSignal: *mut core::ffi::c_void, // HANDLE
hObjectToWaitOn: *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 SignalObjectAndWait(IntPtr hObjectToSignal, IntPtr hObjectToWaitOn, uint dwMilliseconds, bool bAlertable);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SignalObjectAndWait' -Namespace Win32 -PassThru
# $api::SignalObjectAndWait(hObjectToSignal, hObjectToWaitOn, dwMilliseconds, bAlertable)#uselib "KERNEL32.dll"
#func global SignalObjectAndWait "SignalObjectAndWait" sptr, sptr, sptr, sptr
; SignalObjectAndWait hObjectToSignal, hObjectToWaitOn, dwMilliseconds, bAlertable ; 戻り値は stat
; hObjectToSignal : HANDLE -> "sptr"
; hObjectToWaitOn : HANDLE -> "sptr"
; dwMilliseconds : DWORD -> "sptr"
; bAlertable : BOOL -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "KERNEL32.dll"
#cfunc global SignalObjectAndWait "SignalObjectAndWait" sptr, sptr, int, int
; res = SignalObjectAndWait(hObjectToSignal, hObjectToWaitOn, dwMilliseconds, bAlertable)
; hObjectToSignal : HANDLE -> "sptr"
; hObjectToWaitOn : HANDLE -> "sptr"
; dwMilliseconds : DWORD -> "int"
; bAlertable : BOOL -> "int"; WAIT_EVENT SignalObjectAndWait(HANDLE hObjectToSignal, HANDLE hObjectToWaitOn, DWORD dwMilliseconds, BOOL bAlertable)
#uselib "KERNEL32.dll"
#cfunc global SignalObjectAndWait "SignalObjectAndWait" intptr, intptr, int, int
; res = SignalObjectAndWait(hObjectToSignal, hObjectToWaitOn, dwMilliseconds, bAlertable)
; hObjectToSignal : HANDLE -> "intptr"
; hObjectToWaitOn : HANDLE -> "intptr"
; dwMilliseconds : DWORD -> "int"
; bAlertable : BOOL -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
procSignalObjectAndWait = kernel32.NewProc("SignalObjectAndWait")
)
// hObjectToSignal (HANDLE), hObjectToWaitOn (HANDLE), dwMilliseconds (DWORD), bAlertable (BOOL)
r1, _, err := procSignalObjectAndWait.Call(
uintptr(hObjectToSignal),
uintptr(hObjectToWaitOn),
uintptr(dwMilliseconds),
uintptr(bAlertable),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // WAIT_EVENTfunction SignalObjectAndWait(
hObjectToSignal: THandle; // HANDLE
hObjectToWaitOn: THandle; // HANDLE
dwMilliseconds: DWORD; // DWORD
bAlertable: BOOL // BOOL
): DWORD; stdcall;
external 'KERNEL32.dll' name 'SignalObjectAndWait';result := DllCall("KERNEL32\SignalObjectAndWait"
, "Ptr", hObjectToSignal ; HANDLE
, "Ptr", hObjectToWaitOn ; HANDLE
, "UInt", dwMilliseconds ; DWORD
, "Int", bAlertable ; BOOL
, "UInt") ; return: WAIT_EVENT●SignalObjectAndWait(hObjectToSignal, hObjectToWaitOn, dwMilliseconds, bAlertable) = DLL("KERNEL32.dll", "dword SignalObjectAndWait(void*, void*, dword, bool)")
# 呼び出し: SignalObjectAndWait(hObjectToSignal, hObjectToWaitOn, dwMilliseconds, bAlertable)
# hObjectToSignal : HANDLE -> "void*"
# hObjectToWaitOn : HANDLE -> "void*"
# dwMilliseconds : DWORD -> "dword"
# bAlertable : BOOL -> "bool"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "kernel32" fn SignalObjectAndWait(
hObjectToSignal: ?*anyopaque, // HANDLE
hObjectToWaitOn: ?*anyopaque, // HANDLE
dwMilliseconds: u32, // DWORD
bAlertable: i32 // BOOL
) callconv(std.os.windows.WINAPI) u32;proc SignalObjectAndWait(
hObjectToSignal: pointer, # HANDLE
hObjectToWaitOn: pointer, # HANDLE
dwMilliseconds: uint32, # DWORD
bAlertable: int32 # BOOL
): uint32 {.importc: "SignalObjectAndWait", stdcall, dynlib: "KERNEL32.dll".}pragma(lib, "kernel32");
extern(Windows)
uint SignalObjectAndWait(
void* hObjectToSignal, // HANDLE
void* hObjectToWaitOn, // HANDLE
uint dwMilliseconds, // DWORD
int bAlertable // BOOL
);ccall((:SignalObjectAndWait, "KERNEL32.dll"), stdcall, UInt32,
(Ptr{Cvoid}, Ptr{Cvoid}, UInt32, Int32),
hObjectToSignal, hObjectToWaitOn, dwMilliseconds, bAlertable)
# hObjectToSignal : HANDLE -> Ptr{Cvoid}
# hObjectToWaitOn : HANDLE -> Ptr{Cvoid}
# dwMilliseconds : DWORD -> UInt32
# bAlertable : BOOL -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
uint32_t SignalObjectAndWait(
void* hObjectToSignal,
void* hObjectToWaitOn,
uint32_t dwMilliseconds,
int32_t bAlertable);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.SignalObjectAndWait(hObjectToSignal, hObjectToWaitOn, dwMilliseconds, bAlertable)
-- hObjectToSignal : HANDLE
-- hObjectToWaitOn : HANDLE
-- dwMilliseconds : DWORD
-- bAlertable : BOOL
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const SignalObjectAndWait = lib.func('__stdcall', 'SignalObjectAndWait', 'uint32_t', ['void *', 'void *', 'uint32_t', 'int32_t']);
// SignalObjectAndWait(hObjectToSignal, hObjectToWaitOn, dwMilliseconds, bAlertable)
// hObjectToSignal : HANDLE -> 'void *'
// hObjectToWaitOn : HANDLE -> 'void *'
// dwMilliseconds : DWORD -> 'uint32_t'
// bAlertable : BOOL -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("KERNEL32.dll", {
SignalObjectAndWait: { parameters: ["pointer", "pointer", "u32", "i32"], result: "u32" },
});
// lib.symbols.SignalObjectAndWait(hObjectToSignal, hObjectToWaitOn, dwMilliseconds, bAlertable)
// hObjectToSignal : HANDLE -> "pointer"
// hObjectToWaitOn : HANDLE -> "pointer"
// dwMilliseconds : DWORD -> "u32"
// bAlertable : BOOL -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t SignalObjectAndWait(
void* hObjectToSignal,
void* hObjectToWaitOn,
uint32_t dwMilliseconds,
int32_t bAlertable);
C, "KERNEL32.dll");
// $ffi->SignalObjectAndWait(hObjectToSignal, hObjectToWaitOn, dwMilliseconds, bAlertable);
// hObjectToSignal : HANDLE
// hObjectToWaitOn : 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 SignalObjectAndWait(
Pointer hObjectToSignal, // HANDLE
Pointer hObjectToWaitOn, // HANDLE
int dwMilliseconds, // DWORD
boolean bAlertable // BOOL
);
}@[Link("kernel32")]
lib LibKERNEL32
fun SignalObjectAndWait = SignalObjectAndWait(
hObjectToSignal : Void*, # HANDLE
hObjectToWaitOn : 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 SignalObjectAndWaitNative = Uint32 Function(Pointer<Void>, Pointer<Void>, Uint32, Int32);
typedef SignalObjectAndWaitDart = int Function(Pointer<Void>, Pointer<Void>, int, int);
final SignalObjectAndWait = DynamicLibrary.open('KERNEL32.dll')
.lookupFunction<SignalObjectAndWaitNative, SignalObjectAndWaitDart>('SignalObjectAndWait');
// hObjectToSignal : HANDLE -> Pointer<Void>
// hObjectToWaitOn : HANDLE -> Pointer<Void>
// dwMilliseconds : DWORD -> Uint32
// bAlertable : BOOL -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function SignalObjectAndWait(
hObjectToSignal: THandle; // HANDLE
hObjectToWaitOn: THandle; // HANDLE
dwMilliseconds: DWORD; // DWORD
bAlertable: BOOL // BOOL
): DWORD; stdcall;
external 'KERNEL32.dll' name 'SignalObjectAndWait';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "SignalObjectAndWait"
c_SignalObjectAndWait :: Ptr () -> Ptr () -> Word32 -> CInt -> IO Word32
-- hObjectToSignal : HANDLE -> Ptr ()
-- hObjectToWaitOn : HANDLE -> Ptr ()
-- dwMilliseconds : DWORD -> Word32
-- bAlertable : BOOL -> CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let signalobjectandwait =
foreign "SignalObjectAndWait"
((ptr void) @-> (ptr void) @-> uint32_t @-> int32_t @-> returning uint32_t)
(* hObjectToSignal : HANDLE -> (ptr void) *)
(* hObjectToWaitOn : 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 ("SignalObjectAndWait" signal-object-and-wait :convention :stdcall) :uint32
(h-object-to-signal :pointer) ; HANDLE
(h-object-to-wait-on :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 $SignalObjectAndWait = Win32::API::More->new('KERNEL32',
'DWORD SignalObjectAndWait(HANDLE hObjectToSignal, HANDLE hObjectToWaitOn, DWORD dwMilliseconds, BOOL bAlertable)');
# my $ret = $SignalObjectAndWait->Call($hObjectToSignal, $hObjectToWaitOn, $dwMilliseconds, $bAlertable);
# hObjectToSignal : HANDLE -> HANDLE
# hObjectToWaitOn : HANDLE -> HANDLE
# dwMilliseconds : DWORD -> DWORD
# bAlertable : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f MsgWaitForMultipleObjects — オブジェクトの待機とメッセージ到着を同時に待つ。
- f MsgWaitForMultipleObjectsEx — 拡張フラグ付きで待機とメッセージ到着を待つ。