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

ResetEvent

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

シグネチャ

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

BOOL ResetEvent(
    HANDLE hEvent
);

パラメーター

名前方向説明
hEventHANDLEin

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

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

戻り値の型: BOOL

公式ドキュメント

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

戻り値

関数が成功した場合、戻り値は 0 以外の値です。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、 GetLastError を呼び出します。

解説(Remarks)

イベントオブジェクトの状態は、 SetEvent 関数または PulseEvent 関数によって明示的にシグナル状態に設定されるまで、非シグナル状態のままになります。この非シグナル状態は、 待機関数 のいずれかの呼び出しでそのイベントオブジェクトを指定したスレッドの実行をブロックします。

ResetEvent 関数は、主に手動リセットイベントオブジェクトに対して使用します。これらのオブジェクトは明示的に非シグナル状態に設定する必要があります。自動リセットイベントオブジェクトは、待機中の単一スレッドが解放された後、自動的にシグナル状態から非シグナル状態へ変化します。

すでにリセットされているイベントをリセットしても、何も起こりません。

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

各言語での呼び出し定義

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

BOOL ResetEvent(
    HANDLE hEvent
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool ResetEvent(
    IntPtr hEvent   // HANDLE
);
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function ResetEvent(
    hEvent As IntPtr   ' HANDLE
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hEvent : HANDLE
Declare PtrSafe Function ResetEvent 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

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procResetEvent = kernel32.NewProc("ResetEvent")
)

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

extern "kernel32" fn ResetEvent(
    hEvent: ?*anyopaque // HANDLE
) callconv(std.os.windows.WINAPI) i32;
proc ResetEvent(
    hEvent: pointer  # HANDLE
): int32 {.importc: "ResetEvent", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int ResetEvent(
    void* hEvent   // HANDLE
);
ccall((:ResetEvent, "KERNEL32.dll"), stdcall, Int32,
      (Ptr{Cvoid},),
      hEvent)
# hEvent : HANDLE -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t ResetEvent(
    void* hEvent);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.ResetEvent(hEvent)
-- hEvent : HANDLE
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const ResetEvent = lib.func('__stdcall', 'ResetEvent', 'int32_t', ['void *']);
// ResetEvent(hEvent)
// hEvent : HANDLE -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  ResetEvent: { parameters: ["pointer"], result: "i32" },
});
// lib.symbols.ResetEvent(hEvent)
// hEvent : HANDLE -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t ResetEvent(
    void* hEvent);
C, "KERNEL32.dll");
// $ffi->ResetEvent(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 ResetEvent(
        Pointer hEvent   // HANDLE
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun ResetEvent = ResetEvent(
    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 ResetEventNative = Int32 Function(Pointer<Void>);
typedef ResetEventDart = int Function(Pointer<Void>);
final ResetEvent = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<ResetEventNative, ResetEventDart>('ResetEvent');
// hEvent : HANDLE -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ResetEvent(
  hEvent: THandle   // HANDLE
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'ResetEvent';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

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

関連項目

公式の関連項目