ホーム › System.EventLog › EvtClearLog
EvtClearLog
関数イベントログを消去し任意でバックアップする。
シグネチャ
// wevtapi.dll
#include <windows.h>
BOOL EvtClearLog(
EVT_HANDLE Session, // optional
LPCWSTR ChannelPath,
LPCWSTR TargetFilePath, // optional
DWORD Flags
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| Session | EVT_HANDLE | inoptional | EvtOpenSession 関数が返すリモートセッションハンドル。ローカルチャネルの場合は NULL を設定します。 |
| ChannelPath | LPCWSTR | in | クリアするチャネルの名前。 |
| TargetFilePath | LPCWSTR | inoptional | イベントを受け取るターゲットログファイルへのフルパス。ログファイルをクリアしてイベントを保存しない場合は NULL を設定します。 |
| Flags | DWORD | in | 予約済み。ゼロを指定する必要があります。 |
戻り値の型: BOOL
公式ドキュメント
指定したチャネルからすべてのイベントを削除し、それらをターゲットのログファイルに書き込みます。
戻り値
| 戻り値/値 | 説明 |
|---|---|
|
関数は成功しました。 |
|
関数は失敗しました。エラーコードを取得するには GetLastError 関数を使用してください。 |
解説(Remarks)
チャネルまたはログファイルからイベントをコピーするには、EvtExportLog 関数を呼び出します。
ターゲットログファイルには絶対パスを指定する必要があります。相対パスや環境変数を使用してターゲットログファイルを指定することはできません。パスには UNC (Universal Naming Convention) パスを使用できます。ファイル名の拡張子には .evtx を使用してください。
この関数はチャネルにのみ影響します。チャネルが autoBackup または fileMax を使用している場合でも、この関数はそれらのバックアップファイルには影響しません。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// wevtapi.dll
#include <windows.h>
BOOL EvtClearLog(
EVT_HANDLE Session, // optional
LPCWSTR ChannelPath,
LPCWSTR TargetFilePath, // optional
DWORD Flags
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("wevtapi.dll", SetLastError = true, ExactSpelling = true)]
static extern bool EvtClearLog(
IntPtr Session, // EVT_HANDLE optional
[MarshalAs(UnmanagedType.LPWStr)] string ChannelPath, // LPCWSTR
[MarshalAs(UnmanagedType.LPWStr)] string TargetFilePath, // LPCWSTR optional
uint Flags // DWORD
);<DllImport("wevtapi.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function EvtClearLog(
Session As IntPtr, ' EVT_HANDLE optional
<MarshalAs(UnmanagedType.LPWStr)> ChannelPath As String, ' LPCWSTR
<MarshalAs(UnmanagedType.LPWStr)> TargetFilePath As String, ' LPCWSTR optional
Flags As UInteger ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' Session : EVT_HANDLE optional
' ChannelPath : LPCWSTR
' TargetFilePath : LPCWSTR optional
' Flags : DWORD
Declare PtrSafe Function EvtClearLog Lib "wevtapi" ( _
ByVal Session As LongPtr, _
ByVal ChannelPath As LongPtr, _
ByVal TargetFilePath 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
EvtClearLog = ctypes.windll.wevtapi.EvtClearLog
EvtClearLog.restype = wintypes.BOOL
EvtClearLog.argtypes = [
ctypes.c_ssize_t, # Session : EVT_HANDLE optional
wintypes.LPCWSTR, # ChannelPath : LPCWSTR
wintypes.LPCWSTR, # TargetFilePath : LPCWSTR 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')
EvtClearLog = Fiddle::Function.new(
lib['EvtClearLog'],
[
Fiddle::TYPE_INTPTR_T, # Session : EVT_HANDLE optional
Fiddle::TYPE_VOIDP, # ChannelPath : LPCWSTR
Fiddle::TYPE_VOIDP, # TargetFilePath : LPCWSTR optional
-Fiddle::TYPE_INT, # Flags : DWORD
],
Fiddle::TYPE_INT)#[link(name = "wevtapi")]
extern "system" {
fn EvtClearLog(
Session: isize, // EVT_HANDLE optional
ChannelPath: *const u16, // LPCWSTR
TargetFilePath: *const u16, // LPCWSTR optional
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 EvtClearLog(IntPtr Session, [MarshalAs(UnmanagedType.LPWStr)] string ChannelPath, [MarshalAs(UnmanagedType.LPWStr)] string TargetFilePath, uint Flags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'wevtapi_EvtClearLog' -Namespace Win32 -PassThru
# $api::EvtClearLog(Session, ChannelPath, TargetFilePath, Flags)#uselib "wevtapi.dll"
#func global EvtClearLog "EvtClearLog" sptr, sptr, sptr, sptr
; EvtClearLog Session, ChannelPath, TargetFilePath, Flags ; 戻り値は stat
; Session : EVT_HANDLE optional -> "sptr"
; ChannelPath : LPCWSTR -> "sptr"
; TargetFilePath : LPCWSTR optional -> "sptr"
; Flags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "wevtapi.dll"
#cfunc global EvtClearLog "EvtClearLog" sptr, wstr, wstr, int
; res = EvtClearLog(Session, ChannelPath, TargetFilePath, Flags)
; Session : EVT_HANDLE optional -> "sptr"
; ChannelPath : LPCWSTR -> "wstr"
; TargetFilePath : LPCWSTR optional -> "wstr"
; Flags : DWORD -> "int"; BOOL EvtClearLog(EVT_HANDLE Session, LPCWSTR ChannelPath, LPCWSTR TargetFilePath, DWORD Flags)
#uselib "wevtapi.dll"
#cfunc global EvtClearLog "EvtClearLog" intptr, wstr, wstr, int
; res = EvtClearLog(Session, ChannelPath, TargetFilePath, Flags)
; Session : EVT_HANDLE optional -> "intptr"
; ChannelPath : LPCWSTR -> "wstr"
; TargetFilePath : LPCWSTR optional -> "wstr"
; Flags : DWORD -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
wevtapi = windows.NewLazySystemDLL("wevtapi.dll")
procEvtClearLog = wevtapi.NewProc("EvtClearLog")
)
// Session (EVT_HANDLE optional), ChannelPath (LPCWSTR), TargetFilePath (LPCWSTR optional), Flags (DWORD)
r1, _, err := procEvtClearLog.Call(
uintptr(Session),
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(ChannelPath))),
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(TargetFilePath))),
uintptr(Flags),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction EvtClearLog(
Session: NativeInt; // EVT_HANDLE optional
ChannelPath: PWideChar; // LPCWSTR
TargetFilePath: PWideChar; // LPCWSTR optional
Flags: DWORD // DWORD
): BOOL; stdcall;
external 'wevtapi.dll' name 'EvtClearLog';result := DllCall("wevtapi\EvtClearLog"
, "Ptr", Session ; EVT_HANDLE optional
, "WStr", ChannelPath ; LPCWSTR
, "WStr", TargetFilePath ; LPCWSTR optional
, "UInt", Flags ; DWORD
, "Int") ; return: BOOL●EvtClearLog(Session, ChannelPath, TargetFilePath, Flags) = DLL("wevtapi.dll", "bool EvtClearLog(int, char*, char*, dword)")
# 呼び出し: EvtClearLog(Session, ChannelPath, TargetFilePath, Flags)
# Session : EVT_HANDLE optional -> "int"
# ChannelPath : LPCWSTR -> "char*"
# TargetFilePath : LPCWSTR optional -> "char*"
# Flags : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "wevtapi" fn EvtClearLog(
Session: isize, // EVT_HANDLE optional
ChannelPath: [*c]const u16, // LPCWSTR
TargetFilePath: [*c]const u16, // LPCWSTR optional
Flags: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;proc EvtClearLog(
Session: int, # EVT_HANDLE optional
ChannelPath: WideCString, # LPCWSTR
TargetFilePath: WideCString, # LPCWSTR optional
Flags: uint32 # DWORD
): int32 {.importc: "EvtClearLog", stdcall, dynlib: "wevtapi.dll".}pragma(lib, "wevtapi");
extern(Windows)
int EvtClearLog(
ptrdiff_t Session, // EVT_HANDLE optional
const(wchar)* ChannelPath, // LPCWSTR
const(wchar)* TargetFilePath, // LPCWSTR optional
uint Flags // DWORD
);ccall((:EvtClearLog, "wevtapi.dll"), stdcall, Int32,
(Int, Cwstring, Cwstring, UInt32),
Session, ChannelPath, TargetFilePath, Flags)
# Session : EVT_HANDLE optional -> Int
# ChannelPath : LPCWSTR -> Cwstring
# TargetFilePath : LPCWSTR optional -> Cwstring
# Flags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t EvtClearLog(
intptr_t Session,
const uint16_t* ChannelPath,
const uint16_t* TargetFilePath,
uint32_t Flags);
]]
local wevtapi = ffi.load("wevtapi")
-- wevtapi.EvtClearLog(Session, ChannelPath, TargetFilePath, Flags)
-- Session : EVT_HANDLE optional
-- ChannelPath : LPCWSTR
-- TargetFilePath : LPCWSTR optional
-- Flags : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('wevtapi.dll');
const EvtClearLog = lib.func('__stdcall', 'EvtClearLog', 'int32_t', ['intptr_t', 'str16', 'str16', 'uint32_t']);
// EvtClearLog(Session, ChannelPath, TargetFilePath, Flags)
// Session : EVT_HANDLE optional -> 'intptr_t'
// ChannelPath : LPCWSTR -> 'str16'
// TargetFilePath : LPCWSTR optional -> 'str16'
// Flags : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("wevtapi.dll", {
EvtClearLog: { parameters: ["isize", "buffer", "buffer", "u32"], result: "i32" },
});
// lib.symbols.EvtClearLog(Session, ChannelPath, TargetFilePath, Flags)
// Session : EVT_HANDLE optional -> "isize"
// ChannelPath : LPCWSTR -> "buffer"
// TargetFilePath : LPCWSTR optional -> "buffer"
// Flags : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t EvtClearLog(
intptr_t Session,
const uint16_t* ChannelPath,
const uint16_t* TargetFilePath,
uint32_t Flags);
C, "wevtapi.dll");
// $ffi->EvtClearLog(Session, ChannelPath, TargetFilePath, Flags);
// Session : EVT_HANDLE optional
// ChannelPath : LPCWSTR
// TargetFilePath : LPCWSTR 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);
boolean EvtClearLog(
long Session, // EVT_HANDLE optional
WString ChannelPath, // LPCWSTR
WString TargetFilePath, // LPCWSTR optional
int Flags // DWORD
);
}@[Link("wevtapi")]
lib Libwevtapi
fun EvtClearLog = EvtClearLog(
Session : LibC::SSizeT, # EVT_HANDLE optional
ChannelPath : UInt16*, # LPCWSTR
TargetFilePath : UInt16*, # LPCWSTR optional
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 EvtClearLogNative = Int32 Function(IntPtr, Pointer<Utf16>, Pointer<Utf16>, Uint32);
typedef EvtClearLogDart = int Function(int, Pointer<Utf16>, Pointer<Utf16>, int);
final EvtClearLog = DynamicLibrary.open('wevtapi.dll')
.lookupFunction<EvtClearLogNative, EvtClearLogDart>('EvtClearLog');
// Session : EVT_HANDLE optional -> IntPtr
// ChannelPath : LPCWSTR -> Pointer<Utf16>
// TargetFilePath : LPCWSTR optional -> Pointer<Utf16>
// Flags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function EvtClearLog(
Session: NativeInt; // EVT_HANDLE optional
ChannelPath: PWideChar; // LPCWSTR
TargetFilePath: PWideChar; // LPCWSTR optional
Flags: DWORD // DWORD
): BOOL; stdcall;
external 'wevtapi.dll' name 'EvtClearLog';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "EvtClearLog"
c_EvtClearLog :: CIntPtr -> CWString -> CWString -> Word32 -> IO CInt
-- Session : EVT_HANDLE optional -> CIntPtr
-- ChannelPath : LPCWSTR -> CWString
-- TargetFilePath : LPCWSTR optional -> CWString
-- Flags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let evtclearlog =
foreign "EvtClearLog"
(intptr_t @-> (ptr uint16_t) @-> (ptr uint16_t) @-> uint32_t @-> returning int32_t)
(* Session : EVT_HANDLE optional -> intptr_t *)
(* ChannelPath : LPCWSTR -> (ptr uint16_t) *)
(* TargetFilePath : LPCWSTR optional -> (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 ("EvtClearLog" evt-clear-log :convention :stdcall) :int32
(session :int64) ; EVT_HANDLE optional
(channel-path (:string :encoding :utf-16le)) ; LPCWSTR
(target-file-path (:string :encoding :utf-16le)) ; LPCWSTR optional
(flags :uint32)) ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $EvtClearLog = Win32::API::More->new('wevtapi',
'BOOL EvtClearLog(LPARAM Session, LPCWSTR ChannelPath, LPCWSTR TargetFilePath, DWORD Flags)');
# my $ret = $EvtClearLog->Call($Session, $ChannelPath, $TargetFilePath, $Flags);
# Session : EVT_HANDLE optional -> LPARAM
# ChannelPath : LPCWSTR -> LPCWSTR
# TargetFilePath : LPCWSTR optional -> LPCWSTR
# Flags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
公式の関連項目
- f EvtArchiveExportedLog — エクスポート済みログをアーカイブ化する。
- f EvtExportLog — 条件に合うイベントをファイルへエクスポートする。