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

NotifyChangeEventLog

関数
イベントログの変更通知をイベントに設定する。
DLLADVAPI32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL NotifyChangeEventLog(
    HANDLE hEventLog,
    HANDLE hEvent
);

パラメーター

名前方向説明
hEventLogHANDLEinイベントログのハンドル。 OpenEventLog 関数がこのハンドルを返します。
hEventHANDLEin手動リセットまたは自動リセットのイベントオブジェクトへのハンドル。イベントオブジェクトの作成には CreateEvent 関数を使用します。

戻り値の型: BOOL

公式ドキュメント

イベントが指定したイベントログに書き込まれたときに、アプリケーションが通知を受け取れるようにします。

戻り値

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

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

解説(Remarks)

NotifyChangeEventLog 関数はリモートハンドルでは動作しません。hEventLog パラメーターがリモートコンピューター上のイベントログのハンドルである場合、NotifyChangeEventLog は 0 を返し、 GetLastErrorERROR_INVALID_HANDLE を返します。

システムが PulseEvent を呼び出す時点でスレッドがイベントを待機していない場合、そのスレッドは通知を受け取りません。したがって、通知を待機するための専用のスレッドを作成してください。

システムは、イベントログのハンドルを閉じるまで変更の通知を続けます。イベントログを閉じるには、 CloseEventLog 関数または DeregisterEventSource 関数を使用します。

例については、Receiving Event Notification を参照してください。

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

各言語での呼び出し定義

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

BOOL NotifyChangeEventLog(
    HANDLE hEventLog,
    HANDLE hEvent
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool NotifyChangeEventLog(
    IntPtr hEventLog,   // HANDLE
    IntPtr hEvent   // HANDLE
);
<DllImport("ADVAPI32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function NotifyChangeEventLog(
    hEventLog As IntPtr,   ' HANDLE
    hEvent As IntPtr   ' HANDLE
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hEventLog : HANDLE
' hEvent : HANDLE
Declare PtrSafe Function NotifyChangeEventLog Lib "advapi32" ( _
    ByVal hEventLog As LongPtr, _
    ByVal hEvent As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

NotifyChangeEventLog = ctypes.windll.advapi32.NotifyChangeEventLog
NotifyChangeEventLog.restype = wintypes.BOOL
NotifyChangeEventLog.argtypes = [
    wintypes.HANDLE,  # hEventLog : HANDLE
    wintypes.HANDLE,  # hEvent : HANDLE
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
NotifyChangeEventLog = Fiddle::Function.new(
  lib['NotifyChangeEventLog'],
  [
    Fiddle::TYPE_VOIDP,  # hEventLog : HANDLE
    Fiddle::TYPE_VOIDP,  # hEvent : HANDLE
  ],
  Fiddle::TYPE_INT)
#[link(name = "advapi32")]
extern "system" {
    fn NotifyChangeEventLog(
        hEventLog: *mut core::ffi::c_void,  // HANDLE
        hEvent: *mut core::ffi::c_void  // HANDLE
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", SetLastError = true)]
public static extern bool NotifyChangeEventLog(IntPtr hEventLog, IntPtr hEvent);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_NotifyChangeEventLog' -Namespace Win32 -PassThru
# $api::NotifyChangeEventLog(hEventLog, hEvent)
#uselib "ADVAPI32.dll"
#func global NotifyChangeEventLog "NotifyChangeEventLog" sptr, sptr
; NotifyChangeEventLog hEventLog, hEvent   ; 戻り値は stat
; hEventLog : HANDLE -> "sptr"
; hEvent : HANDLE -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "ADVAPI32.dll"
#cfunc global NotifyChangeEventLog "NotifyChangeEventLog" sptr, sptr
; res = NotifyChangeEventLog(hEventLog, hEvent)
; hEventLog : HANDLE -> "sptr"
; hEvent : HANDLE -> "sptr"
; BOOL NotifyChangeEventLog(HANDLE hEventLog, HANDLE hEvent)
#uselib "ADVAPI32.dll"
#cfunc global NotifyChangeEventLog "NotifyChangeEventLog" intptr, intptr
; res = NotifyChangeEventLog(hEventLog, hEvent)
; hEventLog : HANDLE -> "intptr"
; hEvent : HANDLE -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procNotifyChangeEventLog = advapi32.NewProc("NotifyChangeEventLog")
)

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

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

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

let notifychangeeventlog =
  foreign "NotifyChangeEventLog"
    ((ptr void) @-> (ptr void) @-> returning int32_t)
(* hEventLog : HANDLE -> (ptr void) *)
(* hEvent : HANDLE -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library advapi32 (t "ADVAPI32.dll"))
(cffi:use-foreign-library advapi32)

(cffi:defcfun ("NotifyChangeEventLog" notify-change-event-log :convention :stdcall) :int32
  (h-event-log :pointer)   ; HANDLE
  (h-event :pointer))   ; HANDLE
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $NotifyChangeEventLog = Win32::API::More->new('ADVAPI32',
    'BOOL NotifyChangeEventLog(HANDLE hEventLog, HANDLE hEvent)');
# my $ret = $NotifyChangeEventLog->Call($hEventLog, $hEvent);
# hEventLog : HANDLE -> HANDLE
# hEvent : HANDLE -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目