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

EvtQuery

関数
条件を指定してイベントログを問い合わせる。
DLLwevtapi.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

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

パラメーター

名前方向説明
SessionEVT_HANDLEinoptionalEvtOpenSession 関数が返すリモートセッションハンドルです。ローカルコンピューター上のイベントを照会する場合は NULL に設定します。
PathLPCWSTRinoptional照会対象のイベントを含むチャネルの名前、またはログファイルへのフルパスです。.evt、.evtx、.etl のいずれかのログファイルを指定できます。Query パラメーターに XPath クエリを指定する場合、このパスは必須です。Query パラメーターに構造化 XML クエリを指定し、そのクエリ内でパスを指定している場合、このパスは無視されます。
QueryLPCWSTRinoptional取得対象とするイベントの種類を指定するクエリです。XPath 1.0 クエリまたは構造化 XML クエリを指定できます。XPath に 21 個以上の式が含まれる場合は、構造化 XML クエリを使用してください。すべてのイベントを受け取るには、このパラメーターを NULL または "*" に設定します。
FlagsDWORDinイベントを受け取る順序、およびチャネルとログファイルのどちらに対して照会するかを指定する 1 つ以上のフラグです。指定可能な値については、EVT_QUERY_FLAGS 列挙型を参照してください。

戻り値の型: EVT_HANDLE

公式ドキュメント

指定したクエリ条件に一致するイベントを、チャネルまたはログファイルから取得するためのクエリを実行します。

戻り値

成功した場合はクエリ結果へのハンドル、それ以外の場合は NULL を返します。この関数が NULL を返した場合は、GetLastError 関数を呼び出してエラーコードを取得してください。

解説(Remarks)

クエリ結果からイベントを取得するには、EvtNext 関数を呼び出します。結果内の特定のイベントから取得を開始するには、EvtSeek 関数を呼び出します。

処理が完了したら、クエリ結果ハンドルを指定して EvtClose 関数を呼び出す必要があります。

この関数が返すクエリハンドルは、そのハンドルを作成したスレッドと同じスレッドでのみ使用してください。

この関数の使用例については、Querying for Events を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 EvtQuery(
    EVT_HANDLE Session,   // optional
    LPCWSTR Path,   // optional
    LPCWSTR Query,   // optional
    DWORD Flags
);
[DllImport("wevtapi.dll", SetLastError = true, ExactSpelling = true)]
static extern IntPtr EvtQuery(
    IntPtr Session,   // EVT_HANDLE optional
    [MarshalAs(UnmanagedType.LPWStr)] string Path,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string Query,   // LPCWSTR optional
    uint Flags   // DWORD
);
<DllImport("wevtapi.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function EvtQuery(
    Session As IntPtr,   ' EVT_HANDLE optional
    <MarshalAs(UnmanagedType.LPWStr)> Path As String,   ' LPCWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> Query As String,   ' LPCWSTR optional
    Flags As UInteger   ' DWORD
) As IntPtr
End Function
' Session : EVT_HANDLE optional
' Path : LPCWSTR optional
' Query : LPCWSTR optional
' Flags : DWORD
Declare PtrSafe Function EvtQuery Lib "wevtapi" ( _
    ByVal Session As LongPtr, _
    ByVal Path As LongPtr, _
    ByVal Query 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

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

var (
	wevtapi = windows.NewLazySystemDLL("wevtapi.dll")
	procEvtQuery = wevtapi.NewProc("EvtQuery")
)

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

extern "wevtapi" fn EvtQuery(
    Session: isize, // EVT_HANDLE optional
    Path: [*c]const u16, // LPCWSTR optional
    Query: [*c]const u16, // LPCWSTR optional
    Flags: u32 // DWORD
) callconv(std.os.windows.WINAPI) isize;
proc EvtQuery(
    Session: int,  # EVT_HANDLE optional
    Path: WideCString,  # LPCWSTR optional
    Query: WideCString,  # LPCWSTR optional
    Flags: uint32  # DWORD
): int {.importc: "EvtQuery", stdcall, dynlib: "wevtapi.dll".}
pragma(lib, "wevtapi");
extern(Windows)
ptrdiff_t EvtQuery(
    ptrdiff_t Session,   // EVT_HANDLE optional
    const(wchar)* Path,   // LPCWSTR optional
    const(wchar)* Query,   // LPCWSTR optional
    uint Flags   // DWORD
);
ccall((:EvtQuery, "wevtapi.dll"), stdcall, Int,
      (Int, Cwstring, Cwstring, UInt32),
      Session, Path, Query, Flags)
# Session : EVT_HANDLE optional -> Int
# Path : LPCWSTR optional -> Cwstring
# Query : LPCWSTR optional -> Cwstring
# Flags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
intptr_t EvtQuery(
    intptr_t Session,
    const uint16_t* Path,
    const uint16_t* Query,
    uint32_t Flags);
]]
local wevtapi = ffi.load("wevtapi")
-- wevtapi.EvtQuery(Session, Path, Query, Flags)
-- Session : EVT_HANDLE optional
-- Path : LPCWSTR optional
-- Query : LPCWSTR optional
-- Flags : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('wevtapi.dll');
const EvtQuery = lib.func('__stdcall', 'EvtQuery', 'intptr_t', ['intptr_t', 'str16', 'str16', 'uint32_t']);
// EvtQuery(Session, Path, Query, Flags)
// Session : EVT_HANDLE optional -> 'intptr_t'
// Path : LPCWSTR optional -> 'str16'
// Query : LPCWSTR optional -> 'str16'
// Flags : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("wevtapi.dll", {
  EvtQuery: { parameters: ["isize", "buffer", "buffer", "u32"], result: "isize" },
});
// lib.symbols.EvtQuery(Session, Path, Query, Flags)
// Session : EVT_HANDLE optional -> "isize"
// Path : LPCWSTR optional -> "buffer"
// Query : LPCWSTR optional -> "buffer"
// Flags : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
intptr_t EvtQuery(
    intptr_t Session,
    const uint16_t* Path,
    const uint16_t* Query,
    uint32_t Flags);
C, "wevtapi.dll");
// $ffi->EvtQuery(Session, Path, Query, Flags);
// Session : EVT_HANDLE optional
// Path : LPCWSTR optional
// Query : LPCWSTR optional
// 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 EvtQuery(
        long Session,   // EVT_HANDLE optional
        WString Path,   // LPCWSTR optional
        WString Query,   // LPCWSTR optional
        int Flags   // DWORD
    );
}
@[Link("wevtapi")]
lib Libwevtapi
  fun EvtQuery = EvtQuery(
    Session : LibC::SSizeT,   # EVT_HANDLE optional
    Path : UInt16*,   # LPCWSTR optional
    Query : UInt16*,   # LPCWSTR optional
    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 EvtQueryNative = IntPtr Function(IntPtr, Pointer<Utf16>, Pointer<Utf16>, Uint32);
typedef EvtQueryDart = int Function(int, Pointer<Utf16>, Pointer<Utf16>, int);
final EvtQuery = DynamicLibrary.open('wevtapi.dll')
    .lookupFunction<EvtQueryNative, EvtQueryDart>('EvtQuery');
// Session : EVT_HANDLE optional -> IntPtr
// Path : LPCWSTR optional -> Pointer<Utf16>
// Query : LPCWSTR optional -> Pointer<Utf16>
// Flags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function EvtQuery(
  Session: NativeInt;   // EVT_HANDLE optional
  Path: PWideChar;   // LPCWSTR optional
  Query: PWideChar;   // LPCWSTR optional
  Flags: DWORD   // DWORD
): NativeInt; stdcall;
  external 'wevtapi.dll' name 'EvtQuery';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let evtquery =
  foreign "EvtQuery"
    (intptr_t @-> (ptr uint16_t) @-> (ptr uint16_t) @-> uint32_t @-> returning intptr_t)
(* Session : EVT_HANDLE optional -> intptr_t *)
(* Path : LPCWSTR optional -> (ptr uint16_t) *)
(* Query : LPCWSTR optional -> (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 ("EvtQuery" evt-query :convention :stdcall) :int64
  (session :int64)   ; EVT_HANDLE optional
  (path (:string :encoding :utf-16le))   ; LPCWSTR optional
  (query (:string :encoding :utf-16le))   ; LPCWSTR optional
  (flags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $EvtQuery = Win32::API::More->new('wevtapi',
    'LPARAM EvtQuery(LPARAM Session, LPCWSTR Path, LPCWSTR Query, DWORD Flags)');
# my $ret = $EvtQuery->Call($Session, $Path, $Query, $Flags);
# Session : EVT_HANDLE optional -> LPARAM
# Path : LPCWSTR optional -> LPCWSTR
# Query : LPCWSTR optional -> LPCWSTR
# Flags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目