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

EvtOpenEventMetadataEnum

関数
イベントメタデータの列挙を開始する。
DLLwevtapi.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

EVT_HANDLE EvtOpenEventMetadataEnum(
    EVT_HANDLE PublisherMetadata,
    DWORD Flags
);

パラメーター

名前方向説明
PublisherMetadataEVT_HANDLEinEvtOpenPublisherMetadata 関数が返す、プロバイダーのメタデータへのハンドルです。
FlagsDWORDin予約済みです。0 を指定する必要があります。

戻り値の型: EVT_HANDLE

公式ドキュメント

プロバイダーが定義するイベントの一覧を列挙するために使用するハンドルを取得します。

戻り値

成功した場合、この関数はプロバイダーが定義するイベントの一覧へのハンドルを返します。失敗した場合は NULL を返します。NULL の場合は、GetLastError 関数を呼び出してエラーコードを取得してください。

解説(Remarks)

イベントを列挙するには、EvtNextEventMetadata 関数をループ内で呼び出します。

列挙が完了したら、EvtClose 関数を呼び出して列挙子ハンドルを閉じる必要があります。

この関数の使用方法を示す例については、Getting a Provider's Metadata を参照してください。

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

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

var (
	wevtapi = windows.NewLazySystemDLL("wevtapi.dll")
	procEvtOpenEventMetadataEnum = wevtapi.NewProc("EvtOpenEventMetadataEnum")
)

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

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

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

let evtopeneventmetadataenum =
  foreign "EvtOpenEventMetadataEnum"
    (intptr_t @-> uint32_t @-> returning intptr_t)
(* PublisherMetadata : EVT_HANDLE -> intptr_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 ("EvtOpenEventMetadataEnum" evt-open-event-metadata-enum :convention :stdcall) :int64
  (publisher-metadata :int64)   ; EVT_HANDLE
  (flags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $EvtOpenEventMetadataEnum = Win32::API::More->new('wevtapi',
    'LPARAM EvtOpenEventMetadataEnum(LPARAM PublisherMetadata, DWORD Flags)');
# my $ret = $EvtOpenEventMetadataEnum->Call($PublisherMetadata, $Flags);
# PublisherMetadata : EVT_HANDLE -> LPARAM
# Flags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目