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

CreateEventA

関数
名前付きまたは無名のイベントを作成する(ANSI版)。
DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// KERNEL32.dll  (ANSI / -A)
#include <windows.h>

HANDLE CreateEventA(
    SECURITY_ATTRIBUTES* lpEventAttributes,   // optional
    BOOL bManualReset,
    BOOL bInitialState,
    LPCSTR lpName   // optional
);

パラメーター

名前方向説明
lpEventAttributesSECURITY_ATTRIBUTES*inoptional

SECURITY_ATTRIBUTES 構造体へのポインターです。このパラメーターが NULL の場合、ハンドルは子プロセスに継承されません。

構造体の lpSecurityDescriptor メンバーは、新しいイベントの セキュリティ記述子 を指定します。lpEventAttributesNULL の場合、イベントには既定のセキュリティ記述子が割り当てられます。イベントの既定のセキュリティ記述子内の ACL は、作成者のプライマリトークンまたは偽装トークンに由来します。

bManualResetBOOLinこのパラメーターが TRUE の場合、関数は手動リセットイベントオブジェクトを作成します。このオブジェクトでは、イベントの状態を非シグナル状態に設定するために ResetEvent 関数を使用する必要があります。このパラメーターが FALSE の場合、関数は自動リセットイベントオブジェクトを作成し、待機している単一のスレッドが解放された後、システムが自動的にイベントの状態を非シグナル状態にリセットします。
bInitialStateBOOLinこのパラメーターが TRUE の場合、イベントオブジェクトの初期状態はシグナル状態になります。そうでない場合は非シグナル状態になります。
lpNameLPCSTRinoptional

イベントオブジェクトの名前です。名前は MAX_PATH 文字までに制限されます。名前の比較では大文字と小文字が区別されます。

lpName が既存の名前付きイベントオブジェクトの名前と一致する場合、この関数は EVENT_ALL_ACCESS アクセス権を要求します。この場合、bManualReset および bInitialState パラメーターは、作成元のプロセスによって既に設定されているため無視されます。lpEventAttributes パラメーターが NULL でない場合、それはハンドルを継承できるかどうかを決定しますが、そのセキュリティ記述子メンバーは無視されます。

lpNameNULL の場合、イベントオブジェクトは名前なしで作成されます。

lpName が同じ名前空間内の別の種類のオブジェクト(既存のセマフォ、ミューテックス、待機可能タイマー、ジョブ、ファイルマッピングオブジェクトなど)の名前と一致する場合、関数は失敗し、GetLastError 関数は ERROR_INVALID_HANDLE を返します。これは、これらのオブジェクトが同じ名前空間を共有しているために発生します。

名前には "Global" または "Local" プレフィックスを付けて、オブジェクトをグローバル名前空間またはセッション名前空間に明示的に作成できます。名前の残りの部分には、円記号 (\) を除く任意の文字を含めることができます。詳細については、Kernel Object Namespaces を参照してください。高速ユーザー切り替えは、ターミナルサービスのセッションを使用して実装されています。アプリケーションが複数のユーザーをサポートできるように、カーネルオブジェクト名はターミナルサービス向けに示されているガイドラインに従う必要があります。

オブジェクトはプライベート名前空間に作成できます。詳細については、Object Namespaces を参照してください。

戻り値の型: HANDLE

公式ドキュメント

名前付きまたは名前なしのイベントオブジェクトを作成または開きます。(ANSI)

戻り値

関数が成功した場合、戻り値はイベントオブジェクトへのハンドルです。名前付きイベントオブジェクトが関数の呼び出し前に既に存在していた場合、関数は既存のオブジェクトへのハンドルを返し、GetLastErrorERROR_ALREADY_EXISTS を返します。

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

解説(Remarks)

CreateEvent が返すハンドルは EVENT_ALL_ACCESS アクセス権を持ちます。呼び出し元にアクセスが許可されていれば、イベントオブジェクトへのハンドルを必要とする任意の関数で使用できます。サービスから、または別のユーザーを偽装しているスレッドからイベントを作成する場合は、イベントの作成時にセキュリティ記述子を適用するか、作成元プロセスの既定の DACL を変更してその既定のセキュリティ記述子を変更できます。詳細については、Synchronization Object Security and Access Rights を参照してください。

呼び出し元プロセスの任意のスレッドは、待機関数 のいずれかの呼び出しでイベントオブジェクトのハンドルを指定できます。単一オブジェクトの待機関数は、指定したオブジェクトの状態がシグナル状態になったときに戻ります。複数オブジェクトの待機関数は、指定したオブジェクトのいずれか 1 つがシグナル状態になったとき、またはすべてがシグナル状態になったときのいずれかで戻るように指示できます。待機関数が戻ると、待機していたスレッドは解放され、実行を継続します。

イベントオブジェクトの初期状態は bInitialState パラメーターで指定されます。イベントオブジェクトの状態をシグナル状態に設定するには SetEvent 関数を使用します。イベントオブジェクトの状態を非シグナル状態にリセットするには ResetEvent 関数を使用します。

手動リセットイベントオブジェクトの状態がシグナル状態になると、ResetEvent 関数によって明示的に非シグナル状態にリセットされるまで、シグナル状態のまま保たれます。オブジェクトの状態がシグナル状態である間は、待機している任意の数のスレッド、またはその後に指定したイベントオブジェクトの待機操作を開始するスレッドを解放できます。

自動リセットイベントオブジェクトの状態がシグナル状態になると、待機している単一のスレッドが解放されるまでシグナル状態のまま保たれ、その後システムが自動的に状態を非シグナル状態にリセットします。待機しているスレッドがない場合、イベントオブジェクトの状態はシグナル状態のまま保たれます。

複数のプロセスが同じイベントオブジェクトのハンドルを持つことができ、プロセス間同期のためにオブジェクトを使用できます。次のオブジェクト共有メカニズムが利用できます。

ハンドルを閉じるには CloseHandle 関数を使用します。プロセスが終了すると、システムは自動的にハンドルを閉じます。イベントオブジェクトは、その最後のハンドルが閉じられたときに破棄されます。

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

メモ

synchapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして CreateEvent を定義しています。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存ではないコードと混在させると、コンパイルエラーまたは実行時エラーを引き起こす不整合が生じる可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

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

各言語での呼び出し定義

// KERNEL32.dll  (ANSI / -A)
#include <windows.h>

HANDLE CreateEventA(
    SECURITY_ATTRIBUTES* lpEventAttributes,   // optional
    BOOL bManualReset,
    BOOL bInitialState,
    LPCSTR lpName   // optional
);
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern IntPtr CreateEventA(
    IntPtr lpEventAttributes,   // SECURITY_ATTRIBUTES* optional
    bool bManualReset,   // BOOL
    bool bInitialState,   // BOOL
    [MarshalAs(UnmanagedType.LPStr)] string lpName   // LPCSTR optional
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CreateEventA(
    lpEventAttributes As IntPtr,   ' SECURITY_ATTRIBUTES* optional
    bManualReset As Boolean,   ' BOOL
    bInitialState As Boolean,   ' BOOL
    <MarshalAs(UnmanagedType.LPStr)> lpName As String   ' LPCSTR optional
) As IntPtr
End Function
' lpEventAttributes : SECURITY_ATTRIBUTES* optional
' bManualReset : BOOL
' bInitialState : BOOL
' lpName : LPCSTR optional
Declare PtrSafe Function CreateEventA Lib "kernel32" ( _
    ByVal lpEventAttributes As LongPtr, _
    ByVal bManualReset As Long, _
    ByVal bInitialState As Long, _
    ByVal lpName As String) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CreateEventA = ctypes.windll.kernel32.CreateEventA
CreateEventA.restype = ctypes.c_void_p
CreateEventA.argtypes = [
    ctypes.c_void_p,  # lpEventAttributes : SECURITY_ATTRIBUTES* optional
    wintypes.BOOL,  # bManualReset : BOOL
    wintypes.BOOL,  # bInitialState : BOOL
    wintypes.LPCSTR,  # lpName : LPCSTR optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
CreateEventA = Fiddle::Function.new(
  lib['CreateEventA'],
  [
    Fiddle::TYPE_VOIDP,  # lpEventAttributes : SECURITY_ATTRIBUTES* optional
    Fiddle::TYPE_INT,  # bManualReset : BOOL
    Fiddle::TYPE_INT,  # bInitialState : BOOL
    Fiddle::TYPE_VOIDP,  # lpName : LPCSTR optional
  ],
  Fiddle::TYPE_VOIDP)
#[link(name = "kernel32")]
extern "system" {
    fn CreateEventA(
        lpEventAttributes: *mut SECURITY_ATTRIBUTES,  // SECURITY_ATTRIBUTES* optional
        bManualReset: i32,  // BOOL
        bInitialState: i32,  // BOOL
        lpName: *const u8  // LPCSTR optional
    ) -> *mut core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern IntPtr CreateEventA(IntPtr lpEventAttributes, bool bManualReset, bool bInitialState, [MarshalAs(UnmanagedType.LPStr)] string lpName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_CreateEventA' -Namespace Win32 -PassThru
# $api::CreateEventA(lpEventAttributes, bManualReset, bInitialState, lpName)
#uselib "KERNEL32.dll"
#func global CreateEventA "CreateEventA" sptr, sptr, sptr, sptr
; CreateEventA varptr(lpEventAttributes), bManualReset, bInitialState, lpName   ; 戻り値は stat
; lpEventAttributes : SECURITY_ATTRIBUTES* optional -> "sptr"
; bManualReset : BOOL -> "sptr"
; bInitialState : BOOL -> "sptr"
; lpName : LPCSTR optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global CreateEventA "CreateEventA" var, int, int, str
; res = CreateEventA(lpEventAttributes, bManualReset, bInitialState, lpName)
; lpEventAttributes : SECURITY_ATTRIBUTES* optional -> "var"
; bManualReset : BOOL -> "int"
; bInitialState : BOOL -> "int"
; lpName : LPCSTR optional -> "str"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HANDLE CreateEventA(SECURITY_ATTRIBUTES* lpEventAttributes, BOOL bManualReset, BOOL bInitialState, LPCSTR lpName)
#uselib "KERNEL32.dll"
#cfunc global CreateEventA "CreateEventA" var, int, int, str
; res = CreateEventA(lpEventAttributes, bManualReset, bInitialState, lpName)
; lpEventAttributes : SECURITY_ATTRIBUTES* optional -> "var"
; bManualReset : BOOL -> "int"
; bInitialState : BOOL -> "int"
; lpName : LPCSTR optional -> "str"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procCreateEventA = kernel32.NewProc("CreateEventA")
)

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

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

typedef CreateEventANative = Pointer<Void> Function(Pointer<Void>, Int32, Int32, Pointer<Utf8>);
typedef CreateEventADart = Pointer<Void> Function(Pointer<Void>, int, int, Pointer<Utf8>);
final CreateEventA = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<CreateEventANative, CreateEventADart>('CreateEventA');
// lpEventAttributes : SECURITY_ATTRIBUTES* optional -> Pointer<Void>
// bManualReset : BOOL -> Int32
// bInitialState : BOOL -> Int32
// lpName : LPCSTR optional -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CreateEventA(
  lpEventAttributes: Pointer;   // SECURITY_ATTRIBUTES* optional
  bManualReset: BOOL;   // BOOL
  bInitialState: BOOL;   // BOOL
  lpName: PAnsiChar   // LPCSTR optional
): THandle; stdcall;
  external 'KERNEL32.dll' name 'CreateEventA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CreateEventA"
  c_CreateEventA :: Ptr () -> CInt -> CInt -> CString -> IO (Ptr ())
-- lpEventAttributes : SECURITY_ATTRIBUTES* optional -> Ptr ()
-- bManualReset : BOOL -> CInt
-- bInitialState : BOOL -> CInt
-- lpName : LPCSTR optional -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let createeventa =
  foreign "CreateEventA"
    ((ptr void) @-> int32_t @-> int32_t @-> string @-> returning (ptr void))
(* lpEventAttributes : SECURITY_ATTRIBUTES* optional -> (ptr void) *)
(* bManualReset : BOOL -> int32_t *)
(* bInitialState : BOOL -> int32_t *)
(* lpName : LPCSTR optional -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("CreateEventA" create-event-a :convention :stdcall) :pointer
  (lp-event-attributes :pointer)   ; SECURITY_ATTRIBUTES* optional
  (b-manual-reset :int32)   ; BOOL
  (b-initial-state :int32)   ; BOOL
  (lp-name :string))   ; LPCSTR optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CreateEventA = Win32::API::More->new('KERNEL32',
    'HANDLE CreateEventA(LPVOID lpEventAttributes, BOOL bManualReset, BOOL bInitialState, LPCSTR lpName)');
# my $ret = $CreateEventA->Call($lpEventAttributes, $bManualReset, $bInitialState, $lpName);
# lpEventAttributes : SECURITY_ATTRIBUTES* optional -> LPVOID
# bManualReset : BOOL -> BOOL
# bInitialState : BOOL -> BOOL
# lpName : LPCSTR optional -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
類似 API
公式の関連項目
使用する型