CreateEventW

関数

名前付きまたは無名のイベントを作成する(Unicode版)。

DLLKERNEL32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// KERNEL32.dll  (Unicode / -W)
#include <windows.h>

HANDLE CreateEventW(
    SECURITY_ATTRIBUTES* lpEventAttributes,   // optional
    BOOL bManualReset,
    BOOL bInitialState,
    LPCWSTR lpName   // optional
);

パラメーター

名前	型	方向	説明
lpEventAttributes	SECURITY_ATTRIBUTES*	inoptional	SECURITY_ATTRIBUTES 構造体へのポインターです。このパラメーターが NULL の場合、ハンドルは子プロセスに継承できません。構造体の lpSecurityDescriptor メンバーは、新しいイベントのセキュリティ記述子を指定します。lpEventAttributes が NULL の場合、イベントには既定のセキュリティ記述子が割り当てられます。イベントの既定のセキュリティ記述子内の ACL は、作成者のプライマリトークンまたは偽装トークンに由来します。
bManualReset	BOOL	in	このパラメーターが TRUE の場合、関数は手動リセットのイベントオブジェクトを作成します。イベントの状態を非シグナル状態に設定するには ResetEvent 関数を使用する必要があります。このパラメーターが FALSE の場合、関数は自動リセットのイベントオブジェクトを作成し、待機していた単一のスレッドが解放された後、システムが自動的にイベントの状態を非シグナル状態にリセットします。
bInitialState	BOOL	in	このパラメーターが TRUE の場合、イベントオブジェクトの初期状態はシグナル状態になります。それ以外の場合は非シグナル状態になります。
lpName	LPCWSTR	inoptional	イベントオブジェクトの名前です。名前は MAX_PATH 文字までに制限されます。名前の比較では大文字と小文字が区別されます。 lpName が既存の名前付きイベントオブジェクトの名前と一致する場合、この関数は EVENT_ALL_ACCESS アクセス権を要求します。この場合、bManualReset および bInitialState パラメーターは無視されます。これらは作成元のプロセスによって既に設定されているためです。lpEventAttributes パラメーターが NULL でない場合、それによってハンドルを継承できるかどうかが決定されますが、そのセキュリティ記述子メンバーは無視されます。 lpName が NULL の場合、イベントオブジェクトは名前なしで作成されます。 lpName が同じ名前空間内の別種のオブジェクト(既存のセマフォ、ミューテックス、待機可能タイマー、ジョブ、ファイルマッピングオブジェクトなど)の名前と一致する場合、関数は失敗し、GetLastError 関数は ERROR_INVALID_HANDLE を返します。これは、これらのオブジェクトが同じ名前空間を共有するために発生します。名前には "Global" または "Local" のプレフィックスを付けて、オブジェクトをグローバル名前空間またはセッション名前空間に明示的に作成できます。名前の残りの部分には、円記号(\)を除く任意の文字を含めることができます。詳細については、Kernel Object Namespaces を参照してください。高速ユーザー切り替えはターミナルサービスのセッションを使用して実装されています。アプリケーションが複数のユーザーをサポートできるように、カーネルオブジェクト名はターミナルサービスのガイドラインに従う必要があります。オブジェクトはプライベート名前空間に作成できます。詳細については、Object Namespaces を参照してください。

戻り値の型: HANDLE

公式ドキュメント

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

戻り値

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

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

解説(Remarks)

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

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

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

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

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

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

CreateProcess 関数によって作成された子プロセスは、CreateEvent の lpEventAttributes パラメーターで継承が有効になっていれば、イベントオブジェクトへのハンドルを継承できます。
プロセスは DuplicateHandle 関数の呼び出しでイベントオブジェクトのハンドルを指定し、別のプロセスが使用できる複製ハンドルを作成できます。
プロセスは OpenEvent 関数または CreateEvent 関数の呼び出しでイベントオブジェクトの名前を指定できます。

ハンドルを閉じるには 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  (Unicode / -W)
#include <windows.h>

HANDLE CreateEventW(
    SECURITY_ATTRIBUTES* lpEventAttributes,   // optional
    BOOL bManualReset,
    BOOL bInitialState,
    LPCWSTR lpName   // optional
);

[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern IntPtr CreateEventW(
    IntPtr lpEventAttributes,   // SECURITY_ATTRIBUTES* optional
    bool bManualReset,   // BOOL
    bool bInitialState,   // BOOL
    [MarshalAs(UnmanagedType.LPWStr)] string lpName   // LPCWSTR optional
);

<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CreateEventW(
    lpEventAttributes As IntPtr,   ' SECURITY_ATTRIBUTES* optional
    bManualReset As Boolean,   ' BOOL
    bInitialState As Boolean,   ' BOOL
    <MarshalAs(UnmanagedType.LPWStr)> lpName As String   ' LPCWSTR optional
) As IntPtr
End Function

' lpEventAttributes : SECURITY_ATTRIBUTES* optional
' bManualReset : BOOL
' bInitialState : BOOL
' lpName : LPCWSTR optional
Declare PtrSafe Function CreateEventW Lib "kernel32" ( _
    ByVal lpEventAttributes As LongPtr, _
    ByVal bManualReset As Long, _
    ByVal bInitialState As Long, _
    ByVal lpName As LongPtr) As LongPtr
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CreateEventW = ctypes.windll.kernel32.CreateEventW
CreateEventW.restype = ctypes.c_void_p
CreateEventW.argtypes = [
    ctypes.c_void_p,  # lpEventAttributes : SECURITY_ATTRIBUTES* optional
    wintypes.BOOL,  # bManualReset : BOOL
    wintypes.BOOL,  # bInitialState : BOOL
    wintypes.LPCWSTR,  # lpName : LPCWSTR optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
CreateEventW = Fiddle::Function.new(
  lib['CreateEventW'],
  [
    Fiddle::TYPE_VOIDP,  # lpEventAttributes : SECURITY_ATTRIBUTES* optional
    Fiddle::TYPE_INT,  # bManualReset : BOOL
    Fiddle::TYPE_INT,  # bInitialState : BOOL
    Fiddle::TYPE_VOIDP,  # lpName : LPCWSTR optional
  ],
  Fiddle::TYPE_VOIDP)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "kernel32")]
extern "system" {
    fn CreateEventW(
        lpEventAttributes: *mut SECURITY_ATTRIBUTES,  // SECURITY_ATTRIBUTES* optional
        bManualReset: i32,  // BOOL
        bInitialState: i32,  // BOOL
        lpName: *const u16  // LPCWSTR optional
    ) -> *mut core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern IntPtr CreateEventW(IntPtr lpEventAttributes, bool bManualReset, bool bInitialState, [MarshalAs(UnmanagedType.LPWStr)] string lpName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_CreateEventW' -Namespace Win32 -PassThru
# $api::CreateEventW(lpEventAttributes, bManualReset, bInitialState, lpName)

#uselib "KERNEL32.dll"
#func global CreateEventW "CreateEventW" wptr, wptr, wptr, wptr
; CreateEventW varptr(lpEventAttributes), bManualReset, bInitialState, lpName   ; 戻り値は stat
; lpEventAttributes : SECURITY_ATTRIBUTES* optional -> "wptr"
; bManualReset : BOOL -> "wptr"
; bInitialState : BOOL -> "wptr"
; lpName : LPCWSTR optional -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global CreateEventW "CreateEventW" var, int, int, wstr
; res = CreateEventW(lpEventAttributes, bManualReset, bInitialState, lpName)
; lpEventAttributes : SECURITY_ATTRIBUTES* optional -> "var"
; bManualReset : BOOL -> "int"
; bInitialState : BOOL -> "int"
; lpName : LPCWSTR optional -> "wstr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global CreateEventW "CreateEventW" sptr, int, int, wstr
; res = CreateEventW(varptr(lpEventAttributes), bManualReset, bInitialState, lpName)
; lpEventAttributes : SECURITY_ATTRIBUTES* optional -> "sptr"
; bManualReset : BOOL -> "int"
; bInitialState : BOOL -> "int"
; lpName : LPCWSTR optional -> "wstr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。