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

EvtOpenLog

関数
指定したイベントログまたはチャネルを開く。
DLLwevtapi.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

EVT_HANDLE EvtOpenLog(
    EVT_HANDLE Session,   // optional
    LPCWSTR Path,
    DWORD Flags
);

パラメーター

名前方向説明
SessionEVT_HANDLEinoptionalEvtOpenSession 関数が返すリモートセッションハンドルです。ローカルコンピューター上のチャネルまたはログを開くには NULL を設定します。
PathLPCWSTRinチャネルの名前、またはエクスポートされたログファイルへのフルパスです。
FlagsDWORDinPath パラメーターがログファイルとチャネルのどちらを指すかを決定するフラグです。指定可能な値については、EVT_OPEN_LOG_FLAGS 列挙型を参照してください。

戻り値の型: EVT_HANDLE

公式ドキュメント

チャネルまたはログファイルへのハンドルを取得します。このハンドルを使用して、チャネルまたはログファイルに関する情報を取得できます。

戻り値

成功した場合、この関数はファイルまたはチャネルへのハンドルを返します。失敗した場合は NULL を返します。NULL の場合は、GetLastError 関数を呼び出してエラーコードを取得してください。

解説(Remarks)

ファイルを指定する際に、相対パスや環境変数は使用できません。ファイルの場所を指定するために Universal Naming Convention (UNC) パスを使用できます。相対パスの解決や環境変数の展開は、API を呼び出す前に行う必要があります。

チャネルまたはログファイルに関する情報を取得するには、EvtGetLogInfo 関数を呼び出してください。

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

各言語での呼び出し定義

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

EVT_HANDLE EvtOpenLog(
    EVT_HANDLE Session,   // optional
    LPCWSTR Path,
    DWORD Flags
);
[DllImport("wevtapi.dll", SetLastError = true, ExactSpelling = true)]
static extern IntPtr EvtOpenLog(
    IntPtr Session,   // EVT_HANDLE optional
    [MarshalAs(UnmanagedType.LPWStr)] string Path,   // LPCWSTR
    uint Flags   // DWORD
);
<DllImport("wevtapi.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function EvtOpenLog(
    Session As IntPtr,   ' EVT_HANDLE optional
    <MarshalAs(UnmanagedType.LPWStr)> Path As String,   ' LPCWSTR
    Flags As UInteger   ' DWORD
) As IntPtr
End Function
' Session : EVT_HANDLE optional
' Path : LPCWSTR
' Flags : DWORD
Declare PtrSafe Function EvtOpenLog Lib "wevtapi" ( _
    ByVal Session As LongPtr, _
    ByVal Path 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

EvtOpenLog = ctypes.windll.wevtapi.EvtOpenLog
EvtOpenLog.restype = ctypes.c_ssize_t
EvtOpenLog.argtypes = [
    ctypes.c_ssize_t,  # Session : EVT_HANDLE optional
    wintypes.LPCWSTR,  # Path : LPCWSTR
    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')
EvtOpenLog = Fiddle::Function.new(
  lib['EvtOpenLog'],
  [
    Fiddle::TYPE_INTPTR_T,  # Session : EVT_HANDLE optional
    Fiddle::TYPE_VOIDP,  # Path : LPCWSTR
    -Fiddle::TYPE_INT,  # Flags : DWORD
  ],
  Fiddle::TYPE_INTPTR_T)
#[link(name = "wevtapi")]
extern "system" {
    fn EvtOpenLog(
        Session: isize,  // EVT_HANDLE optional
        Path: *const u16,  // LPCWSTR
        Flags: u32  // DWORD
    ) -> isize;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("wevtapi.dll", SetLastError = true)]
public static extern IntPtr EvtOpenLog(IntPtr Session, [MarshalAs(UnmanagedType.LPWStr)] string Path, uint Flags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'wevtapi_EvtOpenLog' -Namespace Win32 -PassThru
# $api::EvtOpenLog(Session, Path, Flags)
#uselib "wevtapi.dll"
#func global EvtOpenLog "EvtOpenLog" sptr, sptr, sptr
; EvtOpenLog Session, Path, Flags   ; 戻り値は stat
; Session : EVT_HANDLE optional -> "sptr"
; Path : LPCWSTR -> "sptr"
; Flags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "wevtapi.dll"
#cfunc global EvtOpenLog "EvtOpenLog" sptr, wstr, int
; res = EvtOpenLog(Session, Path, Flags)
; Session : EVT_HANDLE optional -> "sptr"
; Path : LPCWSTR -> "wstr"
; Flags : DWORD -> "int"
; EVT_HANDLE EvtOpenLog(EVT_HANDLE Session, LPCWSTR Path, DWORD Flags)
#uselib "wevtapi.dll"
#cfunc global EvtOpenLog "EvtOpenLog" intptr, wstr, int
; res = EvtOpenLog(Session, Path, Flags)
; Session : EVT_HANDLE optional -> "intptr"
; Path : LPCWSTR -> "wstr"
; Flags : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wevtapi = windows.NewLazySystemDLL("wevtapi.dll")
	procEvtOpenLog = wevtapi.NewProc("EvtOpenLog")
)

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

extern "wevtapi" fn EvtOpenLog(
    Session: isize, // EVT_HANDLE optional
    Path: [*c]const u16, // LPCWSTR
    Flags: u32 // DWORD
) callconv(std.os.windows.WINAPI) isize;
proc EvtOpenLog(
    Session: int,  # EVT_HANDLE optional
    Path: WideCString,  # LPCWSTR
    Flags: uint32  # DWORD
): int {.importc: "EvtOpenLog", stdcall, dynlib: "wevtapi.dll".}
pragma(lib, "wevtapi");
extern(Windows)
ptrdiff_t EvtOpenLog(
    ptrdiff_t Session,   // EVT_HANDLE optional
    const(wchar)* Path,   // LPCWSTR
    uint Flags   // DWORD
);
ccall((:EvtOpenLog, "wevtapi.dll"), stdcall, Int,
      (Int, Cwstring, UInt32),
      Session, Path, Flags)
# Session : EVT_HANDLE optional -> Int
# Path : LPCWSTR -> Cwstring
# Flags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
intptr_t EvtOpenLog(
    intptr_t Session,
    const uint16_t* Path,
    uint32_t Flags);
]]
local wevtapi = ffi.load("wevtapi")
-- wevtapi.EvtOpenLog(Session, Path, Flags)
-- Session : EVT_HANDLE optional
-- Path : LPCWSTR
-- Flags : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('wevtapi.dll');
const EvtOpenLog = lib.func('__stdcall', 'EvtOpenLog', 'intptr_t', ['intptr_t', 'str16', 'uint32_t']);
// EvtOpenLog(Session, Path, Flags)
// Session : EVT_HANDLE optional -> 'intptr_t'
// Path : LPCWSTR -> 'str16'
// Flags : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("wevtapi.dll", {
  EvtOpenLog: { parameters: ["isize", "buffer", "u32"], result: "isize" },
});
// lib.symbols.EvtOpenLog(Session, Path, Flags)
// Session : EVT_HANDLE optional -> "isize"
// Path : LPCWSTR -> "buffer"
// Flags : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
intptr_t EvtOpenLog(
    intptr_t Session,
    const uint16_t* Path,
    uint32_t Flags);
C, "wevtapi.dll");
// $ffi->EvtOpenLog(Session, Path, Flags);
// Session : EVT_HANDLE optional
// Path : LPCWSTR
// Flags : DWORD
// 構造体/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 Wevtapi extends StdCallLibrary {
    Wevtapi INSTANCE = Native.load("wevtapi", Wevtapi.class);
    long EvtOpenLog(
        long Session,   // EVT_HANDLE optional
        WString Path,   // LPCWSTR
        int Flags   // DWORD
    );
}
@[Link("wevtapi")]
lib Libwevtapi
  fun EvtOpenLog = EvtOpenLog(
    Session : LibC::SSizeT,   # EVT_HANDLE optional
    Path : UInt16*,   # LPCWSTR
    Flags : UInt32   # DWORD
  ) : LibC::SSizeT
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef EvtOpenLogNative = IntPtr Function(IntPtr, Pointer<Utf16>, Uint32);
typedef EvtOpenLogDart = int Function(int, Pointer<Utf16>, int);
final EvtOpenLog = DynamicLibrary.open('wevtapi.dll')
    .lookupFunction<EvtOpenLogNative, EvtOpenLogDart>('EvtOpenLog');
// Session : EVT_HANDLE optional -> IntPtr
// Path : LPCWSTR -> Pointer<Utf16>
// Flags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function EvtOpenLog(
  Session: NativeInt;   // EVT_HANDLE optional
  Path: PWideChar;   // LPCWSTR
  Flags: DWORD   // DWORD
): NativeInt; stdcall;
  external 'wevtapi.dll' name 'EvtOpenLog';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "EvtOpenLog"
  c_EvtOpenLog :: CIntPtr -> CWString -> Word32 -> IO CIntPtr
-- Session : EVT_HANDLE optional -> CIntPtr
-- Path : LPCWSTR -> CWString
-- Flags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let evtopenlog =
  foreign "EvtOpenLog"
    (intptr_t @-> (ptr uint16_t) @-> uint32_t @-> returning intptr_t)
(* Session : EVT_HANDLE optional -> intptr_t *)
(* Path : LPCWSTR -> (ptr uint16_t) *)
(* Flags : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wevtapi (t "wevtapi.dll"))
(cffi:use-foreign-library wevtapi)

(cffi:defcfun ("EvtOpenLog" evt-open-log :convention :stdcall) :int64
  (session :int64)   ; EVT_HANDLE optional
  (path (:string :encoding :utf-16le))   ; LPCWSTR
  (flags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $EvtOpenLog = Win32::API::More->new('wevtapi',
    'LPARAM EvtOpenLog(LPARAM Session, LPCWSTR Path, DWORD Flags)');
# my $ret = $EvtOpenLog->Call($Session, $Path, $Flags);
# Session : EVT_HANDLE optional -> LPARAM
# Path : LPCWSTR -> LPCWSTR
# Flags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目