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

OpenEventA

関数
既存の名前付きイベントを開く(ANSI版)。
DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

HANDLE OpenEventA(
    SYNCHRONIZATION_ACCESS_RIGHTS dwDesiredAccess,
    BOOL bInheritHandle,
    LPCSTR lpName
);

パラメーター

名前方向説明
dwDesiredAccessSYNCHRONIZATION_ACCESS_RIGHTSinイベントオブジェクトへのアクセス権。指定したオブジェクトのセキュリティ記述子が、呼び出し元プロセスに対して要求されたアクセスを許可しない場合、この関数は失敗します。アクセス権の一覧については、 Synchronization Object Security and Access Rights を参照してください。
bInheritHandleBOOLinこの値が TRUE の場合、このプロセスによって作成されるプロセスはハンドルを継承します。それ以外の場合、プロセスはこのハンドルを継承しません。
lpNameLPCSTRin

開くイベントの名前。名前の比較では大文字と小文字が区別されます。

この関数はプライベート名前空間内のオブジェクトを開くことができます。詳細については、Object Namespaces を参照してください。

ターミナルサービス: 名前には "Global" または "Local" のプレフィックスを付けて、グローバル名前空間またはセッション名前空間内のオブジェクトを明示的に開くことができます。名前の残りの部分には、円記号 (\) を除く任意の文字を含めることができます。詳細については、 Kernel Object Namespaces を参照してください。

注意 ユーザーの簡易切り替えは、ターミナルサービスのセッションを使用して実装されています。最初にログオンするユーザーはセッション 0 を使用し、次にログオンするユーザーはセッション 1 を使用する、というように続きます。アプリケーションが複数のユーザーをサポートできるよう、カーネルオブジェクト名はターミナルサービスについて示されたガイドラインに従う必要があります。

戻り値の型: HANDLE

公式ドキュメント

既存の名前付きイベントオブジェクトを開きます。(ANSI)

戻り値

関数が成功した場合、戻り値はイベントオブジェクトへのハンドルです。

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

解説(Remarks)

OpenEvent 関数を使用すると、複数のプロセスが同じイベントオブジェクトのハンドルを開くことができます。この関数は、いずれかのプロセスが CreateEvent 関数を使用して既にイベントを作成している場合にのみ成功します。呼び出し元プロセスは、返されたハンドルを、イベントオブジェクトへのハンドルを必要とする任意の関数で使用できます。ただし、dwDesiredAccess パラメーターで指定されたアクセスの制限に従います。

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

メモ

synchapi.h ヘッダーは OpenEvent を、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  (ANSI / -A)
#include <windows.h>

HANDLE OpenEventA(
    SYNCHRONIZATION_ACCESS_RIGHTS dwDesiredAccess,
    BOOL bInheritHandle,
    LPCSTR lpName
);
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern IntPtr OpenEventA(
    uint dwDesiredAccess,   // SYNCHRONIZATION_ACCESS_RIGHTS
    bool bInheritHandle,   // BOOL
    [MarshalAs(UnmanagedType.LPStr)] string lpName   // LPCSTR
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function OpenEventA(
    dwDesiredAccess As UInteger,   ' SYNCHRONIZATION_ACCESS_RIGHTS
    bInheritHandle As Boolean,   ' BOOL
    <MarshalAs(UnmanagedType.LPStr)> lpName As String   ' LPCSTR
) As IntPtr
End Function
' dwDesiredAccess : SYNCHRONIZATION_ACCESS_RIGHTS
' bInheritHandle : BOOL
' lpName : LPCSTR
Declare PtrSafe Function OpenEventA Lib "kernel32" ( _
    ByVal dwDesiredAccess As Long, _
    ByVal bInheritHandle 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

OpenEventA = ctypes.windll.kernel32.OpenEventA
OpenEventA.restype = ctypes.c_void_p
OpenEventA.argtypes = [
    wintypes.DWORD,  # dwDesiredAccess : SYNCHRONIZATION_ACCESS_RIGHTS
    wintypes.BOOL,  # bInheritHandle : BOOL
    wintypes.LPCSTR,  # lpName : LPCSTR
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
OpenEventA = Fiddle::Function.new(
  lib['OpenEventA'],
  [
    -Fiddle::TYPE_INT,  # dwDesiredAccess : SYNCHRONIZATION_ACCESS_RIGHTS
    Fiddle::TYPE_INT,  # bInheritHandle : BOOL
    Fiddle::TYPE_VOIDP,  # lpName : LPCSTR
  ],
  Fiddle::TYPE_VOIDP)
#[link(name = "kernel32")]
extern "system" {
    fn OpenEventA(
        dwDesiredAccess: u32,  // SYNCHRONIZATION_ACCESS_RIGHTS
        bInheritHandle: i32,  // BOOL
        lpName: *const u8  // LPCSTR
    ) -> *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 OpenEventA(uint dwDesiredAccess, bool bInheritHandle, [MarshalAs(UnmanagedType.LPStr)] string lpName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_OpenEventA' -Namespace Win32 -PassThru
# $api::OpenEventA(dwDesiredAccess, bInheritHandle, lpName)
#uselib "KERNEL32.dll"
#func global OpenEventA "OpenEventA" sptr, sptr, sptr
; OpenEventA dwDesiredAccess, bInheritHandle, lpName   ; 戻り値は stat
; dwDesiredAccess : SYNCHRONIZATION_ACCESS_RIGHTS -> "sptr"
; bInheritHandle : BOOL -> "sptr"
; lpName : LPCSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global OpenEventA "OpenEventA" int, int, str
; res = OpenEventA(dwDesiredAccess, bInheritHandle, lpName)
; dwDesiredAccess : SYNCHRONIZATION_ACCESS_RIGHTS -> "int"
; bInheritHandle : BOOL -> "int"
; lpName : LPCSTR -> "str"
; HANDLE OpenEventA(SYNCHRONIZATION_ACCESS_RIGHTS dwDesiredAccess, BOOL bInheritHandle, LPCSTR lpName)
#uselib "KERNEL32.dll"
#cfunc global OpenEventA "OpenEventA" int, int, str
; res = OpenEventA(dwDesiredAccess, bInheritHandle, lpName)
; dwDesiredAccess : SYNCHRONIZATION_ACCESS_RIGHTS -> "int"
; bInheritHandle : BOOL -> "int"
; lpName : LPCSTR -> "str"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procOpenEventA = kernel32.NewProc("OpenEventA")
)

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

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

typedef OpenEventANative = Pointer<Void> Function(Uint32, Int32, Pointer<Utf8>);
typedef OpenEventADart = Pointer<Void> Function(int, int, Pointer<Utf8>);
final OpenEventA = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<OpenEventANative, OpenEventADart>('OpenEventA');
// dwDesiredAccess : SYNCHRONIZATION_ACCESS_RIGHTS -> Uint32
// bInheritHandle : BOOL -> Int32
// lpName : LPCSTR -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function OpenEventA(
  dwDesiredAccess: DWORD;   // SYNCHRONIZATION_ACCESS_RIGHTS
  bInheritHandle: BOOL;   // BOOL
  lpName: PAnsiChar   // LPCSTR
): THandle; stdcall;
  external 'KERNEL32.dll' name 'OpenEventA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "OpenEventA"
  c_OpenEventA :: Word32 -> CInt -> CString -> IO (Ptr ())
-- dwDesiredAccess : SYNCHRONIZATION_ACCESS_RIGHTS -> Word32
-- bInheritHandle : BOOL -> CInt
-- lpName : LPCSTR -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let openeventa =
  foreign "OpenEventA"
    (uint32_t @-> int32_t @-> string @-> returning (ptr void))
(* dwDesiredAccess : SYNCHRONIZATION_ACCESS_RIGHTS -> uint32_t *)
(* bInheritHandle : BOOL -> int32_t *)
(* lpName : LPCSTR -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("OpenEventA" open-event-a :convention :stdcall) :pointer
  (dw-desired-access :uint32)   ; SYNCHRONIZATION_ACCESS_RIGHTS
  (b-inherit-handle :int32)   ; BOOL
  (lp-name :string))   ; LPCSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $OpenEventA = Win32::API::More->new('KERNEL32',
    'HANDLE OpenEventA(DWORD dwDesiredAccess, BOOL bInheritHandle, LPCSTR lpName)');
# my $ret = $OpenEventA->Call($dwDesiredAccess, $bInheritHandle, $lpName);
# dwDesiredAccess : SYNCHRONIZATION_ACCESS_RIGHTS -> DWORD
# bInheritHandle : BOOL -> BOOL
# lpName : LPCSTR -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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