CreateEventExW

関数

アクセス権とフラグを指定してイベントを作成する(Unicode版)。

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

シグネチャ

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

HANDLE CreateEventExW(
    SECURITY_ATTRIBUTES* lpEventAttributes,   // optional
    LPCWSTR lpName,   // optional
    CREATE_EVENT dwFlags,
    DWORD dwDesiredAccess
);

パラメーター

名前

型

方向

説明

lpEventAttributes

SECURITY_ATTRIBUTES*

inoptional

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

構造体の lpSecurityDescriptor メンバーは、新しいイベントのセキュリティ記述子を指定します。lpEventAttributes が NULL の場合、イベントには既定のセキュリティ記述子が設定されます。イベントの既定のセキュリティ記述子に含まれる ACL は、作成者のプライマリトークンまたは偽装トークンに由来します。

lpName

LPCWSTR

inoptional

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

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

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

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

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

dwFlags

CREATE_EVENT

このパラメーターには 0 または次のいずれかの値を指定できます。

値

意味

CREATE_EVENT_INITIAL_SET
0x00000002

イベントオブジェクトの初期状態をシグナル状態にします。それ以外の場合は非シグナル状態になります。

CREATE_EVENT_MANUAL_RESET
0x00000001

イベントは ResetEvent 関数を使用して手動でリセットする必要があります。オブジェクトの状態がシグナル状態の間、待機中のスレッド、または指定したイベントオブジェクトに対して以降に待機操作を開始するスレッドは、何個でも解放されます。

このフラグを指定しない場合、システムは 1 つの待機中スレッドを解放した後、自動的にイベントをリセットします。

dwDesiredAccess

DWORD

イベントオブジェクトのアクセスマスクです。アクセス権の一覧については、 Synchronization Object Security and Access Rights を参照してください。

戻り値の型: HANDLE

公式ドキュメント

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

戻り値

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

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

解説(Remarks)

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

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

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

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

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

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

メモ

synchapi.h ヘッダーは CreateEventEx を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコーディング非依存のエイリアスを、エンコーディング非依存でないコードと混在させて使用すると、不一致が生じてコンパイルエラーまたは実行時エラーを引き起こす可能性があります。詳細については、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 CreateEventExW(
    SECURITY_ATTRIBUTES* lpEventAttributes,   // optional
    LPCWSTR lpName,   // optional
    CREATE_EVENT dwFlags,
    DWORD dwDesiredAccess
);

[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern IntPtr CreateEventExW(
    IntPtr lpEventAttributes,   // SECURITY_ATTRIBUTES* optional
    [MarshalAs(UnmanagedType.LPWStr)] string lpName,   // LPCWSTR optional
    uint dwFlags,   // CREATE_EVENT
    uint dwDesiredAccess   // DWORD
);

<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CreateEventExW(
    lpEventAttributes As IntPtr,   ' SECURITY_ATTRIBUTES* optional
    <MarshalAs(UnmanagedType.LPWStr)> lpName As String,   ' LPCWSTR optional
    dwFlags As UInteger,   ' CREATE_EVENT
    dwDesiredAccess As UInteger   ' DWORD
) As IntPtr
End Function

' lpEventAttributes : SECURITY_ATTRIBUTES* optional
' lpName : LPCWSTR optional
' dwFlags : CREATE_EVENT
' dwDesiredAccess : DWORD
Declare PtrSafe Function CreateEventExW Lib "kernel32" ( _
    ByVal lpEventAttributes As LongPtr, _
    ByVal lpName As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal dwDesiredAccess As Long) 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

CreateEventExW = ctypes.windll.kernel32.CreateEventExW
CreateEventExW.restype = ctypes.c_void_p
CreateEventExW.argtypes = [
    ctypes.c_void_p,  # lpEventAttributes : SECURITY_ATTRIBUTES* optional
    wintypes.LPCWSTR,  # lpName : LPCWSTR optional
    wintypes.DWORD,  # dwFlags : CREATE_EVENT
    wintypes.DWORD,  # dwDesiredAccess : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

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

#[link(name = "kernel32")]
extern "system" {
    fn CreateEventExW(
        lpEventAttributes: *mut SECURITY_ATTRIBUTES,  // SECURITY_ATTRIBUTES* optional
        lpName: *const u16,  // LPCWSTR optional
        dwFlags: u32,  // CREATE_EVENT
        dwDesiredAccess: u32  // DWORD
    ) -> *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 CreateEventExW(IntPtr lpEventAttributes, [MarshalAs(UnmanagedType.LPWStr)] string lpName, uint dwFlags, uint dwDesiredAccess);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_CreateEventExW' -Namespace Win32 -PassThru
# $api::CreateEventExW(lpEventAttributes, lpName, dwFlags, dwDesiredAccess)

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

出力引数:

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