ホーム › System.EventLog › EvtNextChannelPath

EvtNextChannelPath

関数

次のチャネルパスを列挙して取得する。

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

シグネチャ

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

BOOL EvtNextChannelPath(
    EVT_HANDLE ChannelEnum,
    DWORD ChannelPathBufferSize,
    LPWSTR ChannelPathBuffer,   // optional
    DWORD* ChannelPathBufferUsed
);

パラメーター

名前	型	方向	説明
ChannelEnum	EVT_HANDLE	in	EvtOpenChannelEnum 関数が返す列挙子へのハンドル。
ChannelPathBufferSize	DWORD	in	ChannelPathBuffer バッファのサイズ(文字数単位)。
ChannelPathBuffer	LPWSTR	outoptional	チャネル名を受け取る、呼び出し側が割り当てたバッファ。必要なバッファサイズを取得するには、このパラメーターを NULL に設定できます。
ChannelPathBufferUsed	DWORD*	out	関数が使用した、呼び出し側が割り当てたバッファのサイズ(文字数単位)。関数が ERROR_INSUFFICIENT_BUFFER で失敗した場合は、必要なバッファサイズ。

戻り値の型: BOOL

公式ドキュメント

列挙子からチャネル名を取得します。

戻り値

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

解説(Remarks)

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

例

この関数の使用例については、Getting and Setting a Channel's Configuration Properties を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

BOOL EvtNextChannelPath(
    EVT_HANDLE ChannelEnum,
    DWORD ChannelPathBufferSize,
    LPWSTR ChannelPathBuffer,   // optional
    DWORD* ChannelPathBufferUsed
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("wevtapi.dll", SetLastError = true, ExactSpelling = true)]
static extern bool EvtNextChannelPath(
    IntPtr ChannelEnum,   // EVT_HANDLE
    uint ChannelPathBufferSize,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder ChannelPathBuffer,   // LPWSTR optional, out
    out uint ChannelPathBufferUsed   // DWORD* out
);

<DllImport("wevtapi.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function EvtNextChannelPath(
    ChannelEnum As IntPtr,   ' EVT_HANDLE
    ChannelPathBufferSize As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> ChannelPathBuffer As System.Text.StringBuilder,   ' LPWSTR optional, out
    <Out> ByRef ChannelPathBufferUsed As UInteger   ' DWORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' ChannelEnum : EVT_HANDLE
' ChannelPathBufferSize : DWORD
' ChannelPathBuffer : LPWSTR optional, out
' ChannelPathBufferUsed : DWORD* out
Declare PtrSafe Function EvtNextChannelPath Lib "wevtapi" ( _
    ByVal ChannelEnum As LongPtr, _
    ByVal ChannelPathBufferSize As Long, _
    ByVal ChannelPathBuffer As LongPtr, _
    ByRef ChannelPathBufferUsed As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

EvtNextChannelPath = ctypes.windll.wevtapi.EvtNextChannelPath
EvtNextChannelPath.restype = wintypes.BOOL
EvtNextChannelPath.argtypes = [
    ctypes.c_ssize_t,  # ChannelEnum : EVT_HANDLE
    wintypes.DWORD,  # ChannelPathBufferSize : DWORD
    wintypes.LPWSTR,  # ChannelPathBuffer : LPWSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # ChannelPathBufferUsed : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('wevtapi.dll')
EvtNextChannelPath = Fiddle::Function.new(
  lib['EvtNextChannelPath'],
  [
    Fiddle::TYPE_INTPTR_T,  # ChannelEnum : EVT_HANDLE
    -Fiddle::TYPE_INT,  # ChannelPathBufferSize : DWORD
    Fiddle::TYPE_VOIDP,  # ChannelPathBuffer : LPWSTR optional, out
    Fiddle::TYPE_VOIDP,  # ChannelPathBufferUsed : DWORD* out
  ],
  Fiddle::TYPE_INT)

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

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

出力引数:

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