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

EvtSubscribe

関数
イベントログのイベントをサブスクライブする。
DLLwevtapi.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

EVT_HANDLE EvtSubscribe(
    EVT_HANDLE Session,   // optional
    HANDLE SignalEvent,   // optional
    LPCWSTR ChannelPath,   // optional
    LPCWSTR Query,   // optional
    EVT_HANDLE Bookmark,   // optional
    void* Context,   // optional
    EVT_SUBSCRIBE_CALLBACK Callback,   // optional
    DWORD Flags
);

パラメーター

名前方向
SessionEVT_HANDLEinoptional
SignalEventHANDLEinoptional
ChannelPathLPCWSTRinoptional
QueryLPCWSTRinoptional
BookmarkEVT_HANDLEinoptional
Contextvoid*inoptional
CallbackEVT_SUBSCRIBE_CALLBACKinoptional
FlagsDWORDin

戻り値の型: EVT_HANDLE

各言語での呼び出し定義

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

EVT_HANDLE EvtSubscribe(
    EVT_HANDLE Session,   // optional
    HANDLE SignalEvent,   // optional
    LPCWSTR ChannelPath,   // optional
    LPCWSTR Query,   // optional
    EVT_HANDLE Bookmark,   // optional
    void* Context,   // optional
    EVT_SUBSCRIBE_CALLBACK Callback,   // optional
    DWORD Flags
);
[DllImport("wevtapi.dll", SetLastError = true, ExactSpelling = true)]
static extern IntPtr EvtSubscribe(
    IntPtr Session,   // EVT_HANDLE optional
    IntPtr SignalEvent,   // HANDLE optional
    [MarshalAs(UnmanagedType.LPWStr)] string ChannelPath,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string Query,   // LPCWSTR optional
    IntPtr Bookmark,   // EVT_HANDLE optional
    IntPtr Context,   // void* optional
    IntPtr Callback,   // EVT_SUBSCRIBE_CALLBACK optional
    uint Flags   // DWORD
);
<DllImport("wevtapi.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function EvtSubscribe(
    Session As IntPtr,   ' EVT_HANDLE optional
    SignalEvent As IntPtr,   ' HANDLE optional
    <MarshalAs(UnmanagedType.LPWStr)> ChannelPath As String,   ' LPCWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> Query As String,   ' LPCWSTR optional
    Bookmark As IntPtr,   ' EVT_HANDLE optional
    Context As IntPtr,   ' void* optional
    Callback As IntPtr,   ' EVT_SUBSCRIBE_CALLBACK optional
    Flags As UInteger   ' DWORD
) As IntPtr
End Function
' Session : EVT_HANDLE optional
' SignalEvent : HANDLE optional
' ChannelPath : LPCWSTR optional
' Query : LPCWSTR optional
' Bookmark : EVT_HANDLE optional
' Context : void* optional
' Callback : EVT_SUBSCRIBE_CALLBACK optional
' Flags : DWORD
Declare PtrSafe Function EvtSubscribe Lib "wevtapi" ( _
    ByVal Session As LongPtr, _
    ByVal SignalEvent As LongPtr, _
    ByVal ChannelPath As LongPtr, _
    ByVal Query As LongPtr, _
    ByVal Bookmark As LongPtr, _
    ByVal Context As LongPtr, _
    ByVal Callback As LongPtr, _
    ByVal Flags As Long) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

EvtSubscribe = ctypes.windll.wevtapi.EvtSubscribe
EvtSubscribe.restype = ctypes.c_ssize_t
EvtSubscribe.argtypes = [
    ctypes.c_ssize_t,  # Session : EVT_HANDLE optional
    wintypes.HANDLE,  # SignalEvent : HANDLE optional
    wintypes.LPCWSTR,  # ChannelPath : LPCWSTR optional
    wintypes.LPCWSTR,  # Query : LPCWSTR optional
    ctypes.c_ssize_t,  # Bookmark : EVT_HANDLE optional
    ctypes.POINTER(None),  # Context : void* optional
    ctypes.c_void_p,  # Callback : EVT_SUBSCRIBE_CALLBACK optional
    wintypes.DWORD,  # Flags : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('wevtapi.dll')
EvtSubscribe = Fiddle::Function.new(
  lib['EvtSubscribe'],
  [
    Fiddle::TYPE_INTPTR_T,  # Session : EVT_HANDLE optional
    Fiddle::TYPE_VOIDP,  # SignalEvent : HANDLE optional
    Fiddle::TYPE_VOIDP,  # ChannelPath : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # Query : LPCWSTR optional
    Fiddle::TYPE_INTPTR_T,  # Bookmark : EVT_HANDLE optional
    Fiddle::TYPE_VOIDP,  # Context : void* optional
    Fiddle::TYPE_VOIDP,  # Callback : EVT_SUBSCRIBE_CALLBACK optional
    -Fiddle::TYPE_INT,  # Flags : DWORD
  ],
  Fiddle::TYPE_INTPTR_T)
#[link(name = "wevtapi")]
extern "system" {
    fn EvtSubscribe(
        Session: isize,  // EVT_HANDLE optional
        SignalEvent: *mut core::ffi::c_void,  // HANDLE optional
        ChannelPath: *const u16,  // LPCWSTR optional
        Query: *const u16,  // LPCWSTR optional
        Bookmark: isize,  // EVT_HANDLE optional
        Context: *mut (),  // void* optional
        Callback: *const core::ffi::c_void,  // EVT_SUBSCRIBE_CALLBACK optional
        Flags: u32  // DWORD
    ) -> isize;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("wevtapi.dll", SetLastError = true)]
public static extern IntPtr EvtSubscribe(IntPtr Session, IntPtr SignalEvent, [MarshalAs(UnmanagedType.LPWStr)] string ChannelPath, [MarshalAs(UnmanagedType.LPWStr)] string Query, IntPtr Bookmark, IntPtr Context, IntPtr Callback, uint Flags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'wevtapi_EvtSubscribe' -Namespace Win32 -PassThru
# $api::EvtSubscribe(Session, SignalEvent, ChannelPath, Query, Bookmark, Context, Callback, Flags)
#uselib "wevtapi.dll"
#func global EvtSubscribe "EvtSubscribe" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; EvtSubscribe Session, SignalEvent, ChannelPath, Query, Bookmark, Context, Callback, Flags   ; 戻り値は stat
; Session : EVT_HANDLE optional -> "sptr"
; SignalEvent : HANDLE optional -> "sptr"
; ChannelPath : LPCWSTR optional -> "sptr"
; Query : LPCWSTR optional -> "sptr"
; Bookmark : EVT_HANDLE optional -> "sptr"
; Context : void* optional -> "sptr"
; Callback : EVT_SUBSCRIBE_CALLBACK optional -> "sptr"
; Flags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "wevtapi.dll"
#cfunc global EvtSubscribe "EvtSubscribe" sptr, sptr, wstr, wstr, sptr, sptr, sptr, int
; res = EvtSubscribe(Session, SignalEvent, ChannelPath, Query, Bookmark, Context, Callback, Flags)
; Session : EVT_HANDLE optional -> "sptr"
; SignalEvent : HANDLE optional -> "sptr"
; ChannelPath : LPCWSTR optional -> "wstr"
; Query : LPCWSTR optional -> "wstr"
; Bookmark : EVT_HANDLE optional -> "sptr"
; Context : void* optional -> "sptr"
; Callback : EVT_SUBSCRIBE_CALLBACK optional -> "sptr"
; Flags : DWORD -> "int"
; EVT_HANDLE EvtSubscribe(EVT_HANDLE Session, HANDLE SignalEvent, LPCWSTR ChannelPath, LPCWSTR Query, EVT_HANDLE Bookmark, void* Context, EVT_SUBSCRIBE_CALLBACK Callback, DWORD Flags)
#uselib "wevtapi.dll"
#cfunc global EvtSubscribe "EvtSubscribe" intptr, intptr, wstr, wstr, intptr, intptr, intptr, int
; res = EvtSubscribe(Session, SignalEvent, ChannelPath, Query, Bookmark, Context, Callback, Flags)
; Session : EVT_HANDLE optional -> "intptr"
; SignalEvent : HANDLE optional -> "intptr"
; ChannelPath : LPCWSTR optional -> "wstr"
; Query : LPCWSTR optional -> "wstr"
; Bookmark : EVT_HANDLE optional -> "intptr"
; Context : void* optional -> "intptr"
; Callback : EVT_SUBSCRIBE_CALLBACK optional -> "intptr"
; Flags : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wevtapi = windows.NewLazySystemDLL("wevtapi.dll")
	procEvtSubscribe = wevtapi.NewProc("EvtSubscribe")
)

// Session (EVT_HANDLE optional), SignalEvent (HANDLE optional), ChannelPath (LPCWSTR optional), Query (LPCWSTR optional), Bookmark (EVT_HANDLE optional), Context (void* optional), Callback (EVT_SUBSCRIBE_CALLBACK optional), Flags (DWORD)
r1, _, err := procEvtSubscribe.Call(
	uintptr(Session),
	uintptr(SignalEvent),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(ChannelPath))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(Query))),
	uintptr(Bookmark),
	uintptr(Context),
	uintptr(Callback),
	uintptr(Flags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // EVT_HANDLE
function EvtSubscribe(
  Session: NativeInt;   // EVT_HANDLE optional
  SignalEvent: THandle;   // HANDLE optional
  ChannelPath: PWideChar;   // LPCWSTR optional
  Query: PWideChar;   // LPCWSTR optional
  Bookmark: NativeInt;   // EVT_HANDLE optional
  Context: Pointer;   // void* optional
  Callback: Pointer;   // EVT_SUBSCRIBE_CALLBACK optional
  Flags: DWORD   // DWORD
): NativeInt; stdcall;
  external 'wevtapi.dll' name 'EvtSubscribe';
result := DllCall("wevtapi\EvtSubscribe"
    , "Ptr", Session   ; EVT_HANDLE optional
    , "Ptr", SignalEvent   ; HANDLE optional
    , "WStr", ChannelPath   ; LPCWSTR optional
    , "WStr", Query   ; LPCWSTR optional
    , "Ptr", Bookmark   ; EVT_HANDLE optional
    , "Ptr", Context   ; void* optional
    , "Ptr", Callback   ; EVT_SUBSCRIBE_CALLBACK optional
    , "UInt", Flags   ; DWORD
    , "Ptr")   ; return: EVT_HANDLE
●EvtSubscribe(Session, SignalEvent, ChannelPath, Query, Bookmark, Context, Callback, Flags) = DLL("wevtapi.dll", "int EvtSubscribe(int, void*, char*, char*, int, void*, void*, dword)")
# 呼び出し: EvtSubscribe(Session, SignalEvent, ChannelPath, Query, Bookmark, Context, Callback, Flags)
# Session : EVT_HANDLE optional -> "int"
# SignalEvent : HANDLE optional -> "void*"
# ChannelPath : LPCWSTR optional -> "char*"
# Query : LPCWSTR optional -> "char*"
# Bookmark : EVT_HANDLE optional -> "int"
# Context : void* optional -> "void*"
# Callback : EVT_SUBSCRIBE_CALLBACK optional -> "void*"
# Flags : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。