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

EvtOpenPublisherMetadata

関数
パブリッシャーのメタデータを開く。
DLLwevtapi.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

EVT_HANDLE EvtOpenPublisherMetadata(
    EVT_HANDLE Session,   // optional
    LPCWSTR PublisherId,
    LPCWSTR LogFilePath,   // optional
    DWORD Locale,
    DWORD Flags
);

パラメーター

名前方向説明
SessionEVT_HANDLEinoptionalEvtOpenSession 関数が返すリモートセッションハンドルです。ローカルコンピューター上のプロバイダーのメタデータを取得する場合は NULL を設定します。
PublisherIdLPCWSTRinプロバイダーの名前です。コンピューターに登録されているプロバイダーの名前を列挙するには、EvtOpenPublisherEnum 関数を呼び出します。
LogFilePathLPCWSTRinoptionalプロバイダーがログに記録したイベントを含む、アーカイブされたログファイルへのフルパスです。アーカイブされたログファイルには、プロバイダーのメタデータも含まれます。プロバイダーがローカルコンピューターに登録されていない場合に、このパラメーターを使用します。登録済みのプロバイダーからメタデータを読み取る場合は NULL を設定します。
LocaleDWORDinプロバイダーからローカライズされたメタデータにアクセスする際に使用するロケール識別子です。ロケール識別子を作成するには、MAKELCID マクロを使用します。呼び出し側スレッドのロケール識別子を使用する場合は 0 を設定します。
FlagsDWORDin予約済みです。ゼロにする必要があります。

戻り値の型: EVT_HANDLE

公式ドキュメント

指定したプロバイダーのメタデータを読み取るために使用するハンドルを取得します。

戻り値

成功した場合、この関数はプロバイダーのメタデータへのハンドルを返します。それ以外の場合は NULL を返します。NULL の場合は、GetLastError 関数を呼び出してエラーコードを取得します。

解説(Remarks)

アーカイブされたログファイルを指定した場合、この関数はログファイル内で指定したプロバイダーのメタデータを検索します。プロバイダーのメタデータがログファイル内で見つからない場合、この関数はローカルコンピューターに登録されているプロバイダーの一覧からプロバイダーを検索します。

プロバイダーのメタデータを読み取るには、EvtGetPublisherMetadataProperty 関数を呼び出します。プロバイダーが定義するイベントを列挙するには、EvtOpenEventMetadataEnum 関数を呼び出します。

処理が完了したら、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 EvtOpenPublisherMetadata(
    EVT_HANDLE Session,   // optional
    LPCWSTR PublisherId,
    LPCWSTR LogFilePath,   // optional
    DWORD Locale,
    DWORD Flags
);
[DllImport("wevtapi.dll", SetLastError = true, ExactSpelling = true)]
static extern IntPtr EvtOpenPublisherMetadata(
    IntPtr Session,   // EVT_HANDLE optional
    [MarshalAs(UnmanagedType.LPWStr)] string PublisherId,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string LogFilePath,   // LPCWSTR optional
    uint Locale,   // DWORD
    uint Flags   // DWORD
);
<DllImport("wevtapi.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function EvtOpenPublisherMetadata(
    Session As IntPtr,   ' EVT_HANDLE optional
    <MarshalAs(UnmanagedType.LPWStr)> PublisherId As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> LogFilePath As String,   ' LPCWSTR optional
    Locale As UInteger,   ' DWORD
    Flags As UInteger   ' DWORD
) As IntPtr
End Function
' Session : EVT_HANDLE optional
' PublisherId : LPCWSTR
' LogFilePath : LPCWSTR optional
' Locale : DWORD
' Flags : DWORD
Declare PtrSafe Function EvtOpenPublisherMetadata Lib "wevtapi" ( _
    ByVal Session As LongPtr, _
    ByVal PublisherId As LongPtr, _
    ByVal LogFilePath As LongPtr, _
    ByVal Locale As Long, _
    ByVal Flags As Long) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

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

var (
	wevtapi = windows.NewLazySystemDLL("wevtapi.dll")
	procEvtOpenPublisherMetadata = wevtapi.NewProc("EvtOpenPublisherMetadata")
)

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

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

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

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

関連項目

公式の関連項目