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

EvtOpenChannelEnum

関数
イベントチャネルの列挙を開始する。
DLLwevtapi.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

EVT_HANDLE EvtOpenChannelEnum(
    EVT_HANDLE Session,   // optional
    DWORD Flags
);

パラメーター

名前方向説明
SessionEVT_HANDLEinoptionalEvtOpenSession 関数が返すリモートセッションハンドル。ローカルコンピューターのチャネルを列挙するには NULL を設定します。
FlagsDWORDin予約済み。0 を指定する必要があります。

戻り値の型: EVT_HANDLE

公式ドキュメント

コンピューターに登録されているチャネルの一覧を列挙するために使用するハンドルを取得します。

戻り値

成功した場合、関数はコンピューターに登録されているチャネル名の一覧へのハンドルを返します。それ以外の場合は NULL を返します。NULL の場合は、GetLastError 関数を呼び出してエラーコードを取得してください。

解説(Remarks)

この列挙には、コンピューターに登録されているプロバイダーが定義したすべてのチャネルが含まれます。チャネル名を列挙するには、EvtNextChannelPath 関数をループ内で呼び出します。名前はアルファベット順にソートされます。

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

この関数の使用方法を示す例については、チャネルの構成プロパティの取得と設定を参照してください。

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

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

var (
	wevtapi = windows.NewLazySystemDLL("wevtapi.dll")
	procEvtOpenChannelEnum = wevtapi.NewProc("EvtOpenChannelEnum")
)

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

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

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

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

関連項目

公式の関連項目