EvtNext

関数

クエリ結果から次のイベントを取得する。

DLLwevtapi.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

BOOL EvtNext(
    EVT_HANDLE ResultSet,
    DWORD EventsSize,
    INT_PTR* Events,
    DWORD Timeout,
    DWORD Flags,
    DWORD* Returned
);

パラメーター

名前	型	方向	説明
ResultSet	EVT_HANDLE	in	EvtQuery 関数または EvtSubscribe 関数が返す、クエリまたはサブスクリプションの結果セットへのハンドルです。
EventsSize	DWORD	in	EventArray 配列内の要素数です。関数は結果セットからこの数の要素を取得しようとします。
Events	INT_PTR*	out	結果セットのイベントへのハンドルが設定される、ハンドルの配列へのポインターです。
Timeout	DWORD	in	結果を待機する時間をミリ秒単位で指定します。タイムアウト値を設定しない場合は INFINITE を指定します。タイムアウトが経過した場合、最後のエラーは ERROR_TIMEOUT に設定されます。
Flags	DWORD	in	予約されています。0 を指定する必要があります。
Returned	DWORD*	inout	配列内で設定されたハンドルの数です。

戻り値の型: BOOL

公式ドキュメント

クエリまたはサブスクリプションの結果から次のイベントを取得します。

戻り値

戻り値/コード	説明
TRUE	関数は成功しました。
FALSE	関数は失敗しました。エラーコードを取得するには、GetLastError 関数を呼び出します。

解説(Remarks)

関数が FALSE を返し、エラーコードが ERROR_NO_MORE_ITEMS になるまで、この関数をループ内で呼び出します。

取得した各イベントについて、EvtCreateRenderContext 関数および EvtRender 関数を呼び出してイベントをレンダリングできます。

受け取った各イベントハンドルに対して EvtClose を呼び出す必要があります。

例

この関数の使用方法を示す例については、Querying for Events および Subscribing to Events を参照してください。

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

各言語での呼び出し定義

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

BOOL EvtNext(
    EVT_HANDLE ResultSet,
    DWORD EventsSize,
    INT_PTR* Events,
    DWORD Timeout,
    DWORD Flags,
    DWORD* Returned
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("wevtapi.dll", SetLastError = true, ExactSpelling = true)]
static extern bool EvtNext(
    IntPtr ResultSet,   // EVT_HANDLE
    uint EventsSize,   // DWORD
    out IntPtr Events,   // INT_PTR* out
    uint Timeout,   // DWORD
    uint Flags,   // DWORD
    ref uint Returned   // DWORD* in/out
);

<DllImport("wevtapi.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function EvtNext(
    ResultSet As IntPtr,   ' EVT_HANDLE
    EventsSize As UInteger,   ' DWORD
    <Out> ByRef Events As IntPtr,   ' INT_PTR* out
    Timeout As UInteger,   ' DWORD
    Flags As UInteger,   ' DWORD
    ByRef Returned As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' ResultSet : EVT_HANDLE
' EventsSize : DWORD
' Events : INT_PTR* out
' Timeout : DWORD
' Flags : DWORD
' Returned : DWORD* in/out
Declare PtrSafe Function EvtNext Lib "wevtapi" ( _
    ByVal ResultSet As LongPtr, _
    ByVal EventsSize As Long, _
    ByRef Events As LongPtr, _
    ByVal Timeout As Long, _
    ByVal Flags As Long, _
    ByRef Returned As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

EvtNext = ctypes.windll.wevtapi.EvtNext
EvtNext.restype = wintypes.BOOL
EvtNext.argtypes = [
    ctypes.c_ssize_t,  # ResultSet : EVT_HANDLE
    wintypes.DWORD,  # EventsSize : DWORD
    ctypes.POINTER(ctypes.c_ssize_t),  # Events : INT_PTR* out
    wintypes.DWORD,  # Timeout : DWORD
    wintypes.DWORD,  # Flags : DWORD
    ctypes.POINTER(wintypes.DWORD),  # Returned : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('wevtapi.dll')
EvtNext = Fiddle::Function.new(
  lib['EvtNext'],
  [
    Fiddle::TYPE_INTPTR_T,  # ResultSet : EVT_HANDLE
    -Fiddle::TYPE_INT,  # EventsSize : DWORD
    Fiddle::TYPE_VOIDP,  # Events : INT_PTR* out
    -Fiddle::TYPE_INT,  # Timeout : DWORD
    -Fiddle::TYPE_INT,  # Flags : DWORD
    Fiddle::TYPE_VOIDP,  # Returned : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "wevtapi")]
extern "system" {
    fn EvtNext(
        ResultSet: isize,  // EVT_HANDLE
        EventsSize: u32,  // DWORD
        Events: *mut isize,  // INT_PTR* out
        Timeout: u32,  // DWORD
        Flags: u32,  // DWORD
        Returned: *mut u32  // DWORD* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("wevtapi.dll", SetLastError = true)]
public static extern bool EvtNext(IntPtr ResultSet, uint EventsSize, out IntPtr Events, uint Timeout, uint Flags, ref uint Returned);
"@
$api = Add-Type -MemberDefinition $sig -Name 'wevtapi_EvtNext' -Namespace Win32 -PassThru
# $api::EvtNext(ResultSet, EventsSize, Events, Timeout, Flags, Returned)

#uselib "wevtapi.dll"
#func global EvtNext "EvtNext" sptr, sptr, sptr, sptr, sptr, sptr
; EvtNext ResultSet, EventsSize, varptr(Events), Timeout, Flags, varptr(Returned)   ; 戻り値は stat
; ResultSet : EVT_HANDLE -> "sptr"
; EventsSize : DWORD -> "sptr"
; Events : INT_PTR* out -> "sptr"
; Timeout : DWORD -> "sptr"
; Flags : DWORD -> "sptr"
; Returned : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "wevtapi.dll"
#cfunc global EvtNext "EvtNext" sptr, int, var, int, int, var
; res = EvtNext(ResultSet, EventsSize, Events, Timeout, Flags, Returned)
; ResultSet : EVT_HANDLE -> "sptr"
; EventsSize : DWORD -> "int"
; Events : INT_PTR* out -> "var"
; Timeout : DWORD -> "int"
; Flags : DWORD -> "int"
; Returned : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "wevtapi.dll"
#cfunc global EvtNext "EvtNext" sptr, int, sptr, int, int, sptr
; res = EvtNext(ResultSet, EventsSize, varptr(Events), Timeout, Flags, varptr(Returned))
; ResultSet : EVT_HANDLE -> "sptr"
; EventsSize : DWORD -> "int"
; Events : INT_PTR* out -> "sptr"
; Timeout : DWORD -> "int"
; Flags : DWORD -> "int"
; Returned : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。