ホーム › System.EventLog › EvtNextPublisherId

EvtNextPublisherId

関数

次のパブリッシャーIDを列挙して取得する。

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

シグネチャ

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

BOOL EvtNextPublisherId(
    EVT_HANDLE PublisherEnum,
    DWORD PublisherIdBufferSize,
    LPWSTR PublisherIdBuffer,   // optional
    DWORD* PublisherIdBufferUsed
);

パラメーター

名前	型	方向	説明
PublisherEnum	EVT_HANDLE	in	EvtOpenPublisherEnum 関数が返す、登録済みプロバイダー列挙子へのハンドルです。
PublisherIdBufferSize	DWORD	in	PublisherIdBuffer バッファのサイズ(文字単位)です。
PublisherIdBuffer	LPWSTR	outoptional	登録済みプロバイダーの名前を受け取る、呼び出し元が割り当てたバッファです。このパラメーターに NULL を設定すると、必要なバッファサイズを取得できます。
PublisherIdBufferUsed	DWORD*	out	関数が使用した、呼び出し元が割り当てたバッファのサイズ(文字単位)です。関数が ERROR_INSUFFICIENT_BUFFER で失敗した場合は、必要なバッファサイズを示します。

戻り値の型: BOOL

公式ドキュメント

列挙子からプロバイダーの識別子を取得します。

戻り値

Return code/value	Description
TRUE	関数は成功しました。
FALSE	関数は失敗しました。エラーコードを取得するには、GetLastError 関数を呼び出してください。

解説(Remarks)

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

このプロバイダー名の一覧はアルファベット順にソートされていません。

例

この関数の使用例については、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 EvtNextPublisherId(
    EVT_HANDLE PublisherEnum,
    DWORD PublisherIdBufferSize,
    LPWSTR PublisherIdBuffer,   // optional
    DWORD* PublisherIdBufferUsed
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("wevtapi.dll", SetLastError = true, ExactSpelling = true)]
static extern bool EvtNextPublisherId(
    IntPtr PublisherEnum,   // EVT_HANDLE
    uint PublisherIdBufferSize,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder PublisherIdBuffer,   // LPWSTR optional, out
    out uint PublisherIdBufferUsed   // DWORD* out
);

<DllImport("wevtapi.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function EvtNextPublisherId(
    PublisherEnum As IntPtr,   ' EVT_HANDLE
    PublisherIdBufferSize As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> PublisherIdBuffer As System.Text.StringBuilder,   ' LPWSTR optional, out
    <Out> ByRef PublisherIdBufferUsed As UInteger   ' DWORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' PublisherEnum : EVT_HANDLE
' PublisherIdBufferSize : DWORD
' PublisherIdBuffer : LPWSTR optional, out
' PublisherIdBufferUsed : DWORD* out
Declare PtrSafe Function EvtNextPublisherId Lib "wevtapi" ( _
    ByVal PublisherEnum As LongPtr, _
    ByVal PublisherIdBufferSize As Long, _
    ByVal PublisherIdBuffer As LongPtr, _
    ByRef PublisherIdBufferUsed As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

EvtNextPublisherId = ctypes.windll.wevtapi.EvtNextPublisherId
EvtNextPublisherId.restype = wintypes.BOOL
EvtNextPublisherId.argtypes = [
    ctypes.c_ssize_t,  # PublisherEnum : EVT_HANDLE
    wintypes.DWORD,  # PublisherIdBufferSize : DWORD
    wintypes.LPWSTR,  # PublisherIdBuffer : LPWSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # PublisherIdBufferUsed : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('wevtapi.dll')
EvtNextPublisherId = Fiddle::Function.new(
  lib['EvtNextPublisherId'],
  [
    Fiddle::TYPE_INTPTR_T,  # PublisherEnum : EVT_HANDLE
    -Fiddle::TYPE_INT,  # PublisherIdBufferSize : DWORD
    Fiddle::TYPE_VOIDP,  # PublisherIdBuffer : LPWSTR optional, out
    Fiddle::TYPE_VOIDP,  # PublisherIdBufferUsed : DWORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "wevtapi")]
extern "system" {
    fn EvtNextPublisherId(
        PublisherEnum: isize,  // EVT_HANDLE
        PublisherIdBufferSize: u32,  // DWORD
        PublisherIdBuffer: *mut u16,  // LPWSTR optional, out
        PublisherIdBufferUsed: *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 EvtNextPublisherId(IntPtr PublisherEnum, uint PublisherIdBufferSize, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder PublisherIdBuffer, out uint PublisherIdBufferUsed);
"@
$api = Add-Type -MemberDefinition $sig -Name 'wevtapi_EvtNextPublisherId' -Namespace Win32 -PassThru
# $api::EvtNextPublisherId(PublisherEnum, PublisherIdBufferSize, PublisherIdBuffer, PublisherIdBufferUsed)

#uselib "wevtapi.dll"
#func global EvtNextPublisherId "EvtNextPublisherId" sptr, sptr, sptr, sptr
; EvtNextPublisherId PublisherEnum, PublisherIdBufferSize, varptr(PublisherIdBuffer), varptr(PublisherIdBufferUsed)   ; 戻り値は stat
; PublisherEnum : EVT_HANDLE -> "sptr"
; PublisherIdBufferSize : DWORD -> "sptr"
; PublisherIdBuffer : LPWSTR optional, out -> "sptr"
; PublisherIdBufferUsed : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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