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

EvtSaveChannelConfig

関数
チャネル構成の変更を保存する。
DLLwevtapi.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

BOOL EvtSaveChannelConfig(
    EVT_HANDLE ChannelConfig,
    DWORD Flags
);

パラメーター

名前方向説明
ChannelConfigEVT_HANDLEinEvtOpenChannelConfig 関数が返すチャネルの構成プロパティへのハンドル。
FlagsDWORDin予約済み。ゼロを指定する必要があります。

戻り値の型: BOOL

公式ドキュメント

チャネルの構成に加えた変更を保存します。

戻り値

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

解説(Remarks)

チャネルの構成プロパティを変更するには、EvtSetChannelConfigProperty 関数を呼び出してください。

この関数は昇格された権限で呼び出す必要があります。そうでない場合、この関数は ERROR_ACCESS_DENIED を返します。

この関数の使用方法を示す例については、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 EvtSaveChannelConfig(
    EVT_HANDLE ChannelConfig,
    DWORD Flags
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("wevtapi.dll", SetLastError = true, ExactSpelling = true)]
static extern bool EvtSaveChannelConfig(
    IntPtr ChannelConfig,   // EVT_HANDLE
    uint Flags   // DWORD
);
<DllImport("wevtapi.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function EvtSaveChannelConfig(
    ChannelConfig As IntPtr,   ' EVT_HANDLE
    Flags As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' ChannelConfig : EVT_HANDLE
' Flags : DWORD
Declare PtrSafe Function EvtSaveChannelConfig Lib "wevtapi" ( _
    ByVal ChannelConfig As LongPtr, _
    ByVal Flags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

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

var (
	wevtapi = windows.NewLazySystemDLL("wevtapi.dll")
	procEvtSaveChannelConfig = wevtapi.NewProc("EvtSaveChannelConfig")
)

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

extern "wevtapi" fn EvtSaveChannelConfig(
    ChannelConfig: isize, // EVT_HANDLE
    Flags: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc EvtSaveChannelConfig(
    ChannelConfig: int,  # EVT_HANDLE
    Flags: uint32  # DWORD
): int32 {.importc: "EvtSaveChannelConfig", stdcall, dynlib: "wevtapi.dll".}
pragma(lib, "wevtapi");
extern(Windows)
int EvtSaveChannelConfig(
    ptrdiff_t ChannelConfig,   // EVT_HANDLE
    uint Flags   // DWORD
);
ccall((:EvtSaveChannelConfig, "wevtapi.dll"), stdcall, Int32,
      (Int, UInt32),
      ChannelConfig, Flags)
# ChannelConfig : EVT_HANDLE -> Int
# Flags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t EvtSaveChannelConfig(
    intptr_t ChannelConfig,
    uint32_t Flags);
]]
local wevtapi = ffi.load("wevtapi")
-- wevtapi.EvtSaveChannelConfig(ChannelConfig, Flags)
-- ChannelConfig : EVT_HANDLE
-- Flags : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('wevtapi.dll');
const EvtSaveChannelConfig = lib.func('__stdcall', 'EvtSaveChannelConfig', 'int32_t', ['intptr_t', 'uint32_t']);
// EvtSaveChannelConfig(ChannelConfig, Flags)
// ChannelConfig : EVT_HANDLE -> 'intptr_t'
// Flags : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("wevtapi.dll", {
  EvtSaveChannelConfig: { parameters: ["isize", "u32"], result: "i32" },
});
// lib.symbols.EvtSaveChannelConfig(ChannelConfig, Flags)
// ChannelConfig : EVT_HANDLE -> "isize"
// Flags : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t EvtSaveChannelConfig(
    intptr_t ChannelConfig,
    uint32_t Flags);
C, "wevtapi.dll");
// $ffi->EvtSaveChannelConfig(ChannelConfig, Flags);
// ChannelConfig : EVT_HANDLE
// 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);
    boolean EvtSaveChannelConfig(
        long ChannelConfig,   // EVT_HANDLE
        int Flags   // DWORD
    );
}
@[Link("wevtapi")]
lib Libwevtapi
  fun EvtSaveChannelConfig = EvtSaveChannelConfig(
    ChannelConfig : LibC::SSizeT,   # EVT_HANDLE
    Flags : UInt32   # DWORD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef EvtSaveChannelConfigNative = Int32 Function(IntPtr, Uint32);
typedef EvtSaveChannelConfigDart = int Function(int, int);
final EvtSaveChannelConfig = DynamicLibrary.open('wevtapi.dll')
    .lookupFunction<EvtSaveChannelConfigNative, EvtSaveChannelConfigDart>('EvtSaveChannelConfig');
// ChannelConfig : EVT_HANDLE -> IntPtr
// Flags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function EvtSaveChannelConfig(
  ChannelConfig: NativeInt;   // EVT_HANDLE
  Flags: DWORD   // DWORD
): BOOL; stdcall;
  external 'wevtapi.dll' name 'EvtSaveChannelConfig';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

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

関連項目

公式の関連項目