ホーム › System.EventLog › EvtSetChannelConfigProperty

EvtSetChannelConfigProperty

関数

チャネル構成のプロパティ値を設定する。

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

シグネチャ

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

BOOL EvtSetChannelConfigProperty(
    EVT_HANDLE ChannelConfig,
    EVT_CHANNEL_CONFIG_PROPERTY_ID PropertyId,
    DWORD Flags,
    EVT_VARIANT* PropertyValue
);

パラメーター

名前	型	方向	説明
ChannelConfig	EVT_HANDLE	in	EvtOpenChannelConfig 関数が返す、チャネルの構成プロパティへのハンドルです。
PropertyId	EVT_CHANNEL_CONFIG_PROPERTY_ID	in	設定するチャネルプロパティの識別子です。プロパティ識別子の一覧については、EVT_CHANNEL_CONFIG_PROPERTY_ID 列挙体を参照してください。
Flags	DWORD	in	予約済みです。ゼロを指定する必要があります。
PropertyValue	EVT_VARIANT*	in	設定するプロパティ値です。新しい構成プロパティ値を格納する、呼び出し元が割り当てたバッファです。このバッファには EVT_VARIANT オブジェクトが含まれます。構成値とバリアント型を必ず設定してください。

戻り値の型: BOOL

公式ドキュメント

チャネルの指定された構成プロパティを設定します。

戻り値

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

解説(Remarks)

この関数は、構成プロパティのメモリ内のコピーを変更します。1 つ以上の構成プロパティに対して行った変更を適用するには、EvtSaveChannelConfig 関数を呼び出してください。

Examples

この関数の使用方法を示す例については、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 EvtSetChannelConfigProperty(
    EVT_HANDLE ChannelConfig,
    EVT_CHANNEL_CONFIG_PROPERTY_ID PropertyId,
    DWORD Flags,
    EVT_VARIANT* PropertyValue
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("wevtapi.dll", SetLastError = true, ExactSpelling = true)]
static extern bool EvtSetChannelConfigProperty(
    IntPtr ChannelConfig,   // EVT_HANDLE
    int PropertyId,   // EVT_CHANNEL_CONFIG_PROPERTY_ID
    uint Flags,   // DWORD
    IntPtr PropertyValue   // EVT_VARIANT*
);

<DllImport("wevtapi.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function EvtSetChannelConfigProperty(
    ChannelConfig As IntPtr,   ' EVT_HANDLE
    PropertyId As Integer,   ' EVT_CHANNEL_CONFIG_PROPERTY_ID
    Flags As UInteger,   ' DWORD
    PropertyValue As IntPtr   ' EVT_VARIANT*
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' ChannelConfig : EVT_HANDLE
' PropertyId : EVT_CHANNEL_CONFIG_PROPERTY_ID
' Flags : DWORD
' PropertyValue : EVT_VARIANT*
Declare PtrSafe Function EvtSetChannelConfigProperty Lib "wevtapi" ( _
    ByVal ChannelConfig As LongPtr, _
    ByVal PropertyId As Long, _
    ByVal Flags As Long, _
    ByVal PropertyValue As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

EvtSetChannelConfigProperty = ctypes.windll.wevtapi.EvtSetChannelConfigProperty
EvtSetChannelConfigProperty.restype = wintypes.BOOL
EvtSetChannelConfigProperty.argtypes = [
    ctypes.c_ssize_t,  # ChannelConfig : EVT_HANDLE
    ctypes.c_int,  # PropertyId : EVT_CHANNEL_CONFIG_PROPERTY_ID
    wintypes.DWORD,  # Flags : DWORD
    ctypes.c_void_p,  # PropertyValue : EVT_VARIANT*
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('wevtapi.dll')
EvtSetChannelConfigProperty = Fiddle::Function.new(
  lib['EvtSetChannelConfigProperty'],
  [
    Fiddle::TYPE_INTPTR_T,  # ChannelConfig : EVT_HANDLE
    Fiddle::TYPE_INT,  # PropertyId : EVT_CHANNEL_CONFIG_PROPERTY_ID
    -Fiddle::TYPE_INT,  # Flags : DWORD
    Fiddle::TYPE_VOIDP,  # PropertyValue : EVT_VARIANT*
  ],
  Fiddle::TYPE_INT)

#[link(name = "wevtapi")]
extern "system" {
    fn EvtSetChannelConfigProperty(
        ChannelConfig: isize,  // EVT_HANDLE
        PropertyId: i32,  // EVT_CHANNEL_CONFIG_PROPERTY_ID
        Flags: u32,  // DWORD
        PropertyValue: *mut EVT_VARIANT  // EVT_VARIANT*
    ) -> 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 EvtSetChannelConfigProperty(IntPtr ChannelConfig, int PropertyId, uint Flags, IntPtr PropertyValue);
"@
$api = Add-Type -MemberDefinition $sig -Name 'wevtapi_EvtSetChannelConfigProperty' -Namespace Win32 -PassThru
# $api::EvtSetChannelConfigProperty(ChannelConfig, PropertyId, Flags, PropertyValue)

#uselib "wevtapi.dll"
#func global EvtSetChannelConfigProperty "EvtSetChannelConfigProperty" sptr, sptr, sptr, sptr
; EvtSetChannelConfigProperty ChannelConfig, PropertyId, Flags, varptr(PropertyValue)   ; 戻り値は stat
; ChannelConfig : EVT_HANDLE -> "sptr"
; PropertyId : EVT_CHANNEL_CONFIG_PROPERTY_ID -> "sptr"
; Flags : DWORD -> "sptr"
; PropertyValue : EVT_VARIANT* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "wevtapi.dll"
#cfunc global EvtSetChannelConfigProperty "EvtSetChannelConfigProperty" sptr, int, int, var
; res = EvtSetChannelConfigProperty(ChannelConfig, PropertyId, Flags, PropertyValue)
; ChannelConfig : EVT_HANDLE -> "sptr"
; PropertyId : EVT_CHANNEL_CONFIG_PROPERTY_ID -> "int"
; Flags : DWORD -> "int"
; PropertyValue : EVT_VARIANT* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "wevtapi.dll"
#cfunc global EvtSetChannelConfigProperty "EvtSetChannelConfigProperty" sptr, int, int, sptr
; res = EvtSetChannelConfigProperty(ChannelConfig, PropertyId, Flags, varptr(PropertyValue))
; ChannelConfig : EVT_HANDLE -> "sptr"
; PropertyId : EVT_CHANNEL_CONFIG_PROPERTY_ID -> "int"
; Flags : DWORD -> "int"
; PropertyValue : EVT_VARIANT* -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。