EvtGetQueryInfo

関数

クエリまたはサブスクリプションの情報を取得する。

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

シグネチャ

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

BOOL EvtGetQueryInfo(
    EVT_HANDLE QueryOrSubscription,
    EVT_QUERY_PROPERTY_ID PropertyId,
    DWORD PropertyValueBufferSize,
    EVT_VARIANT* PropertyValueBuffer,   // optional
    DWORD* PropertyValueBufferUsed
);

パラメーター

名前	型	方向	説明
QueryOrSubscription	EVT_HANDLE	in	EvtQuery 関数または EvtSubscribe 関数が返すクエリへのハンドル。
PropertyId	EVT_QUERY_PROPERTY_ID	in	取得するクエリ情報の識別子。識別子の一覧については、EVT_QUERY_PROPERTY_ID 列挙体を参照してください。
PropertyValueBufferSize	DWORD	in	PropertyValueBuffer バッファのサイズ(バイト単位)。
PropertyValueBuffer	EVT_VARIANT*	outoptional	クエリ情報を受け取る、呼び出し元が割り当てたバッファ。バッファには EVT_VARIANT オブジェクトが格納されます。必要なバッファサイズを確認するには、このパラメーターに NULL を設定できます。
PropertyValueBufferUsed	DWORD*	out	関数が使用した、呼び出し元が割り当てたバッファのサイズ(バイト単位)。関数が ERROR_INSUFFICIENT_BUFFER で失敗した場合は、必要なバッファサイズ。

戻り値の型: BOOL

公式ドキュメント

実行したクエリが、アクセスを試みたチャネルまたはログファイルの一覧を特定するための情報を取得します。この関数は、各アクセスの成否を示すリターンコードの一覧も取得します。

戻り値

リターンコード/値	説明
TRUE	関数は成功しました。
FALSE	関数は失敗しました。エラーコードを取得するには、GetLastError 関数を呼び出してください。

解説(Remarks)

この関数を呼び出す必要があるのは、EvtQuery に EvtQueryTolerateQueryErrors フラグを渡した場合、または EvtSubscribe に EvtSubscribeTolerateQueryErrors フラグを渡した場合のみです。

例

この関数の使用方法を示す例については、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>

BOOL EvtGetQueryInfo(
    EVT_HANDLE QueryOrSubscription,
    EVT_QUERY_PROPERTY_ID PropertyId,
    DWORD PropertyValueBufferSize,
    EVT_VARIANT* PropertyValueBuffer,   // optional
    DWORD* PropertyValueBufferUsed
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("wevtapi.dll", SetLastError = true, ExactSpelling = true)]
static extern bool EvtGetQueryInfo(
    IntPtr QueryOrSubscription,   // EVT_HANDLE
    int PropertyId,   // EVT_QUERY_PROPERTY_ID
    uint PropertyValueBufferSize,   // DWORD
    IntPtr PropertyValueBuffer,   // EVT_VARIANT* optional, out
    out uint PropertyValueBufferUsed   // DWORD* out
);

<DllImport("wevtapi.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function EvtGetQueryInfo(
    QueryOrSubscription As IntPtr,   ' EVT_HANDLE
    PropertyId As Integer,   ' EVT_QUERY_PROPERTY_ID
    PropertyValueBufferSize As UInteger,   ' DWORD
    PropertyValueBuffer As IntPtr,   ' EVT_VARIANT* optional, out
    <Out> ByRef PropertyValueBufferUsed As UInteger   ' DWORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' QueryOrSubscription : EVT_HANDLE
' PropertyId : EVT_QUERY_PROPERTY_ID
' PropertyValueBufferSize : DWORD
' PropertyValueBuffer : EVT_VARIANT* optional, out
' PropertyValueBufferUsed : DWORD* out
Declare PtrSafe Function EvtGetQueryInfo Lib "wevtapi" ( _
    ByVal QueryOrSubscription As LongPtr, _
    ByVal PropertyId As Long, _
    ByVal PropertyValueBufferSize As Long, _
    ByVal PropertyValueBuffer As LongPtr, _
    ByRef PropertyValueBufferUsed As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

EvtGetQueryInfo = ctypes.windll.wevtapi.EvtGetQueryInfo
EvtGetQueryInfo.restype = wintypes.BOOL
EvtGetQueryInfo.argtypes = [
    ctypes.c_ssize_t,  # QueryOrSubscription : EVT_HANDLE
    ctypes.c_int,  # PropertyId : EVT_QUERY_PROPERTY_ID
    wintypes.DWORD,  # PropertyValueBufferSize : DWORD
    ctypes.c_void_p,  # PropertyValueBuffer : EVT_VARIANT* optional, out
    ctypes.POINTER(wintypes.DWORD),  # PropertyValueBufferUsed : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('wevtapi.dll')
EvtGetQueryInfo = Fiddle::Function.new(
  lib['EvtGetQueryInfo'],
  [
    Fiddle::TYPE_INTPTR_T,  # QueryOrSubscription : EVT_HANDLE
    Fiddle::TYPE_INT,  # PropertyId : EVT_QUERY_PROPERTY_ID
    -Fiddle::TYPE_INT,  # PropertyValueBufferSize : DWORD
    Fiddle::TYPE_VOIDP,  # PropertyValueBuffer : EVT_VARIANT* optional, out
    Fiddle::TYPE_VOIDP,  # PropertyValueBufferUsed : DWORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "wevtapi")]
extern "system" {
    fn EvtGetQueryInfo(
        QueryOrSubscription: isize,  // EVT_HANDLE
        PropertyId: i32,  // EVT_QUERY_PROPERTY_ID
        PropertyValueBufferSize: u32,  // DWORD
        PropertyValueBuffer: *mut EVT_VARIANT,  // EVT_VARIANT* optional, out
        PropertyValueBufferUsed: *mut u32  // DWORD* 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 EvtGetQueryInfo(IntPtr QueryOrSubscription, int PropertyId, uint PropertyValueBufferSize, IntPtr PropertyValueBuffer, out uint PropertyValueBufferUsed);
"@
$api = Add-Type -MemberDefinition $sig -Name 'wevtapi_EvtGetQueryInfo' -Namespace Win32 -PassThru
# $api::EvtGetQueryInfo(QueryOrSubscription, PropertyId, PropertyValueBufferSize, PropertyValueBuffer, PropertyValueBufferUsed)

#uselib "wevtapi.dll"
#func global EvtGetQueryInfo "EvtGetQueryInfo" sptr, sptr, sptr, sptr, sptr
; EvtGetQueryInfo QueryOrSubscription, PropertyId, PropertyValueBufferSize, varptr(PropertyValueBuffer), varptr(PropertyValueBufferUsed)   ; 戻り値は stat
; QueryOrSubscription : EVT_HANDLE -> "sptr"
; PropertyId : EVT_QUERY_PROPERTY_ID -> "sptr"
; PropertyValueBufferSize : DWORD -> "sptr"
; PropertyValueBuffer : EVT_VARIANT* optional, out -> "sptr"
; PropertyValueBufferUsed : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "wevtapi.dll"
#cfunc global EvtGetQueryInfo "EvtGetQueryInfo" sptr, int, int, var, var
; res = EvtGetQueryInfo(QueryOrSubscription, PropertyId, PropertyValueBufferSize, PropertyValueBuffer, PropertyValueBufferUsed)
; QueryOrSubscription : EVT_HANDLE -> "sptr"
; PropertyId : EVT_QUERY_PROPERTY_ID -> "int"
; PropertyValueBufferSize : DWORD -> "int"
; PropertyValueBuffer : EVT_VARIANT* optional, out -> "var"
; PropertyValueBufferUsed : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "wevtapi.dll"
#cfunc global EvtGetQueryInfo "EvtGetQueryInfo" sptr, int, int, sptr, sptr
; res = EvtGetQueryInfo(QueryOrSubscription, PropertyId, PropertyValueBufferSize, varptr(PropertyValueBuffer), varptr(PropertyValueBufferUsed))
; QueryOrSubscription : EVT_HANDLE -> "sptr"
; PropertyId : EVT_QUERY_PROPERTY_ID -> "int"
; PropertyValueBufferSize : DWORD -> "int"
; PropertyValueBuffer : EVT_VARIANT* optional, out -> "sptr"
; PropertyValueBufferUsed : DWORD* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。