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

SetEvent

関数
イベントオブジェクトをシグナル状態に設定する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL SetEvent(
    HANDLE hEvent
);

パラメーター

名前方向説明
hEventHANDLEin

イベントオブジェクトへのハンドル。 CreateEvent 関数または OpenEvent 関数がこのハンドルを返します。

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

戻り値の型: BOOL

公式ドキュメント

指定したイベントオブジェクトをシグナル状態に設定します。

戻り値

関数が成功すると、戻り値は 0 以外の値になります。

関数が失敗すると、戻り値は 0 になります。拡張エラー情報を取得するには、 GetLastError を呼び出してください。

解説(Remarks)

手動リセット (manual-reset) イベントオブジェクトの状態は、 ResetEvent 関数によって明示的に非シグナル状態に設定されるまでシグナル状態のままになります。オブジェクトの状態がシグナル状態である間、待機中の任意の数のスレッド、または 待機関数 のいずれかを呼び出して指定したイベントオブジェクトの待機操作を後から開始するスレッドを解放できます。

これに対し、自動リセット (auto-reset) イベントオブジェクトの状態は、1 つの待機中のスレッドが解放されるまでシグナル状態のままになり、解放された時点でシステムが自動的に状態を非シグナル状態に設定します。待機中のスレッドがない場合、イベントオブジェクトの状態はシグナル状態のままになります。

すでに設定されているイベントを設定しても効果はありません。

Windows ストアアプリは、How to respond to named events and semaphores で説明されているように、名前付きイベントおよびセマフォに応答できます。

SetEvent を使用する例については、 Using Event Objects を参照してください。

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

各言語での呼び出し定義

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

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

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

lib = Fiddle.dlopen('KERNEL32.dll')
SetEvent = Fiddle::Function.new(
  lib['SetEvent'],
  [
    Fiddle::TYPE_VOIDP,  # hEvent : HANDLE
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn SetEvent(
        hEvent: *mut core::ffi::c_void  // HANDLE
    ) -> 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 SetEvent(IntPtr hEvent);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetEvent' -Namespace Win32 -PassThru
# $api::SetEvent(hEvent)
#uselib "KERNEL32.dll"
#func global SetEvent "SetEvent" sptr
; SetEvent hEvent   ; 戻り値は stat
; hEvent : HANDLE -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global SetEvent "SetEvent" sptr
; res = SetEvent(hEvent)
; hEvent : HANDLE -> "sptr"
; BOOL SetEvent(HANDLE hEvent)
#uselib "KERNEL32.dll"
#cfunc global SetEvent "SetEvent" intptr
; res = SetEvent(hEvent)
; hEvent : HANDLE -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procSetEvent = kernel32.NewProc("SetEvent")
)

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

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

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

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

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

(cffi:defcfun ("SetEvent" set-event :convention :stdcall) :int32
  (h-event :pointer))   ; HANDLE
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetEvent = Win32::API::More->new('KERNEL32',
    'BOOL SetEvent(HANDLE hEvent)');
# my $ret = $SetEvent->Call($hEvent);
# hEvent : HANDLE -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目