ホーム › System.EventLog › EvtGetPublisherMetadataProperty

EvtGetPublisherMetadataProperty

関数

パブリッシャーメタデータのプロパティを取得する。

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

シグネチャ

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

BOOL EvtGetPublisherMetadataProperty(
    EVT_HANDLE PublisherMetadata,
    EVT_PUBLISHER_METADATA_PROPERTY_ID PropertyId,
    DWORD Flags,
    DWORD PublisherMetadataPropertyBufferSize,
    EVT_VARIANT* PublisherMetadataPropertyBuffer,   // optional
    DWORD* PublisherMetadataPropertyBufferUsed
);

パラメーター

名前	型	方向	説明
PublisherMetadata	EVT_HANDLE	in	EvtOpenPublisherMetadata 関数が返すメタデータへのハンドルです。
PropertyId	EVT_PUBLISHER_METADATA_PROPERTY_ID	in	取得するメタデータプロパティの識別子です。プロパティ識別子の一覧については、EVT_PUBLISHER_METADATA_PROPERTY_ID 列挙型を参照してください。
Flags	DWORD	in	予約済みです。ゼロを指定する必要があります。
PublisherMetadataPropertyBufferSize	DWORD	in	PublisherMetadataPropertyBuffer バッファのサイズ(バイト単位)です。
PublisherMetadataPropertyBuffer	EVT_VARIANT*	outoptional	メタデータプロパティを受け取る、呼び出し側が割り当てたバッファです。このバッファには EVT_VARIANT オブジェクトが格納されます。このパラメーターに NULL を指定すると、必要なバッファサイズを取得できます。
PublisherMetadataPropertyBufferUsed	DWORD*	out	関数が使用した、呼び出し側が割り当てたバッファのサイズ(バイト単位)です。関数が ERROR_INSUFFICIENT_BUFFER で失敗した場合は、必要なバッファサイズが格納されます。

戻り値の型: BOOL

公式ドキュメント

指定したプロバイダーのメタデータプロパティを取得します。

戻り値

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

解説(Remarks)

注意

EvtGetEventMetadataProperty は、EventMetadataPropertyBuffer 変数にさまざまな種類の値を返すことがあります。EventMetadataPropertyBuffer->Type == EvtVarTypeEvtHandle の場合、EventMetadataPropertyBuffer には解放が必要なハンドルが格納されています。ハンドルの使用が終わったら、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>

BOOL EvtGetPublisherMetadataProperty(
    EVT_HANDLE PublisherMetadata,
    EVT_PUBLISHER_METADATA_PROPERTY_ID PropertyId,
    DWORD Flags,
    DWORD PublisherMetadataPropertyBufferSize,
    EVT_VARIANT* PublisherMetadataPropertyBuffer,   // optional
    DWORD* PublisherMetadataPropertyBufferUsed
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("wevtapi.dll", SetLastError = true, ExactSpelling = true)]
static extern bool EvtGetPublisherMetadataProperty(
    IntPtr PublisherMetadata,   // EVT_HANDLE
    int PropertyId,   // EVT_PUBLISHER_METADATA_PROPERTY_ID
    uint Flags,   // DWORD
    uint PublisherMetadataPropertyBufferSize,   // DWORD
    IntPtr PublisherMetadataPropertyBuffer,   // EVT_VARIANT* optional, out
    out uint PublisherMetadataPropertyBufferUsed   // DWORD* out
);

<DllImport("wevtapi.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function EvtGetPublisherMetadataProperty(
    PublisherMetadata As IntPtr,   ' EVT_HANDLE
    PropertyId As Integer,   ' EVT_PUBLISHER_METADATA_PROPERTY_ID
    Flags As UInteger,   ' DWORD
    PublisherMetadataPropertyBufferSize As UInteger,   ' DWORD
    PublisherMetadataPropertyBuffer As IntPtr,   ' EVT_VARIANT* optional, out
    <Out> ByRef PublisherMetadataPropertyBufferUsed As UInteger   ' DWORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' PublisherMetadata : EVT_HANDLE
' PropertyId : EVT_PUBLISHER_METADATA_PROPERTY_ID
' Flags : DWORD
' PublisherMetadataPropertyBufferSize : DWORD
' PublisherMetadataPropertyBuffer : EVT_VARIANT* optional, out
' PublisherMetadataPropertyBufferUsed : DWORD* out
Declare PtrSafe Function EvtGetPublisherMetadataProperty Lib "wevtapi" ( _
    ByVal PublisherMetadata As LongPtr, _
    ByVal PropertyId As Long, _
    ByVal Flags As Long, _
    ByVal PublisherMetadataPropertyBufferSize As Long, _
    ByVal PublisherMetadataPropertyBuffer As LongPtr, _
    ByRef PublisherMetadataPropertyBufferUsed As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

EvtGetPublisherMetadataProperty = ctypes.windll.wevtapi.EvtGetPublisherMetadataProperty
EvtGetPublisherMetadataProperty.restype = wintypes.BOOL
EvtGetPublisherMetadataProperty.argtypes = [
    ctypes.c_ssize_t,  # PublisherMetadata : EVT_HANDLE
    ctypes.c_int,  # PropertyId : EVT_PUBLISHER_METADATA_PROPERTY_ID
    wintypes.DWORD,  # Flags : DWORD
    wintypes.DWORD,  # PublisherMetadataPropertyBufferSize : DWORD
    ctypes.c_void_p,  # PublisherMetadataPropertyBuffer : EVT_VARIANT* optional, out
    ctypes.POINTER(wintypes.DWORD),  # PublisherMetadataPropertyBufferUsed : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('wevtapi.dll')
EvtGetPublisherMetadataProperty = Fiddle::Function.new(
  lib['EvtGetPublisherMetadataProperty'],
  [
    Fiddle::TYPE_INTPTR_T,  # PublisherMetadata : EVT_HANDLE
    Fiddle::TYPE_INT,  # PropertyId : EVT_PUBLISHER_METADATA_PROPERTY_ID
    -Fiddle::TYPE_INT,  # Flags : DWORD
    -Fiddle::TYPE_INT,  # PublisherMetadataPropertyBufferSize : DWORD
    Fiddle::TYPE_VOIDP,  # PublisherMetadataPropertyBuffer : EVT_VARIANT* optional, out
    Fiddle::TYPE_VOIDP,  # PublisherMetadataPropertyBufferUsed : DWORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "wevtapi")]
extern "system" {
    fn EvtGetPublisherMetadataProperty(
        PublisherMetadata: isize,  // EVT_HANDLE
        PropertyId: i32,  // EVT_PUBLISHER_METADATA_PROPERTY_ID
        Flags: u32,  // DWORD
        PublisherMetadataPropertyBufferSize: u32,  // DWORD
        PublisherMetadataPropertyBuffer: *mut EVT_VARIANT,  // EVT_VARIANT* optional, out
        PublisherMetadataPropertyBufferUsed: *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 EvtGetPublisherMetadataProperty(IntPtr PublisherMetadata, int PropertyId, uint Flags, uint PublisherMetadataPropertyBufferSize, IntPtr PublisherMetadataPropertyBuffer, out uint PublisherMetadataPropertyBufferUsed);
"@
$api = Add-Type -MemberDefinition $sig -Name 'wevtapi_EvtGetPublisherMetadataProperty' -Namespace Win32 -PassThru
# $api::EvtGetPublisherMetadataProperty(PublisherMetadata, PropertyId, Flags, PublisherMetadataPropertyBufferSize, PublisherMetadataPropertyBuffer, PublisherMetadataPropertyBufferUsed)

#uselib "wevtapi.dll"
#func global EvtGetPublisherMetadataProperty "EvtGetPublisherMetadataProperty" sptr, sptr, sptr, sptr, sptr, sptr
; EvtGetPublisherMetadataProperty PublisherMetadata, PropertyId, Flags, PublisherMetadataPropertyBufferSize, varptr(PublisherMetadataPropertyBuffer), varptr(PublisherMetadataPropertyBufferUsed)   ; 戻り値は stat
; PublisherMetadata : EVT_HANDLE -> "sptr"
; PropertyId : EVT_PUBLISHER_METADATA_PROPERTY_ID -> "sptr"
; Flags : DWORD -> "sptr"
; PublisherMetadataPropertyBufferSize : DWORD -> "sptr"
; PublisherMetadataPropertyBuffer : EVT_VARIANT* optional, out -> "sptr"
; PublisherMetadataPropertyBufferUsed : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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