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

EvtOpenChannelConfig

関数
イベントチャネルの構成を開く。
DLLwevtapi.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

EVT_HANDLE EvtOpenChannelConfig(
    EVT_HANDLE Session,   // optional
    LPCWSTR ChannelPath,
    DWORD Flags
);

パラメーター

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

戻り値の型: EVT_HANDLE

公式ドキュメント

チャネルの構成プロパティの読み取りまたは変更に使用するハンドルを取得します。

戻り値

成功した場合、この関数はチャネルの構成へのハンドルを返します。失敗した場合は NULL を返します。NULL が返された場合は、GetLastError 関数を呼び出してエラーコードを取得してください。

解説(Remarks)

構成プロパティを取得するには、EvtGetChannelConfigProperty 関数を呼び出します。

構成プロパティを変更するには、EvtSetChannelConfigProperty 関数を呼び出します。構成の変更を保存するには、EvtSaveChannelConfig 関数を呼び出します。

登録されているチャネルを列挙するには、EvtOpenChannelEnum 関数を呼び出します。

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

この関数の使用方法を示す例については、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>

EVT_HANDLE EvtOpenChannelConfig(
    EVT_HANDLE Session,   // optional
    LPCWSTR ChannelPath,
    DWORD Flags
);
[DllImport("wevtapi.dll", SetLastError = true, ExactSpelling = true)]
static extern IntPtr EvtOpenChannelConfig(
    IntPtr Session,   // EVT_HANDLE optional
    [MarshalAs(UnmanagedType.LPWStr)] string ChannelPath,   // LPCWSTR
    uint Flags   // DWORD
);
<DllImport("wevtapi.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function EvtOpenChannelConfig(
    Session As IntPtr,   ' EVT_HANDLE optional
    <MarshalAs(UnmanagedType.LPWStr)> ChannelPath As String,   ' LPCWSTR
    Flags As UInteger   ' DWORD
) As IntPtr
End Function
' Session : EVT_HANDLE optional
' ChannelPath : LPCWSTR
' Flags : DWORD
Declare PtrSafe Function EvtOpenChannelConfig Lib "wevtapi" ( _
    ByVal Session As LongPtr, _
    ByVal ChannelPath 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

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

var (
	wevtapi = windows.NewLazySystemDLL("wevtapi.dll")
	procEvtOpenChannelConfig = wevtapi.NewProc("EvtOpenChannelConfig")
)

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

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

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

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

関連項目

公式の関連項目