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

ClearEventLogW

関数
イベントログを消去する(Unicode版)。
DLLADVAPI32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// ADVAPI32.dll  (Unicode / -W)
#include <windows.h>

BOOL ClearEventLogW(
    HANDLE hEventLog,
    LPCWSTR lpBackupFileName   // optional
);

パラメーター

名前方向説明
hEventLogHANDLEin消去するイベントログのハンドル。OpenEventLog 関数がこのハンドルを返します。
lpBackupFileNameLPCWSTRinoptional

バックアップファイルの絶対パスまたは相対パス。このファイルが既に存在する場合、関数は失敗します。

lpBackupFileName パラメーターが NULL の場合、イベントログはバックアップされません。

戻り値の型: BOOL

公式ドキュメント

指定したイベントログを消去し、オプションでログの現在のコピーをバックアップファイルに保存します。(Unicode)

戻り値

関数が成功すると、戻り値は 0 以外の値になります。

関数が失敗すると、戻り値は 0 になります。拡張エラー情報を取得するには、 GetLastError を呼び出します。 ClearEventLog 関数は、イベントログが空である場合やバックアップファイルが既に存在する場合に失敗することがあります。

解説(Remarks)

この関数が戻った後は、消去されたイベントログを参照するハンドルを使用してログを読み取ることはできません。

メモ

winbase.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして ClearEventLog を定義します。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存でないコードと混在させると、コンパイルエラーや実行時エラーを引き起こす不一致が発生する可能性があります。詳細については、関数プロトタイプの規則 を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// ADVAPI32.dll  (Unicode / -W)
#include <windows.h>

BOOL ClearEventLogW(
    HANDLE hEventLog,
    LPCWSTR lpBackupFileName   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool ClearEventLogW(
    IntPtr hEventLog,   // HANDLE
    [MarshalAs(UnmanagedType.LPWStr)] string lpBackupFileName   // LPCWSTR optional
);
<DllImport("ADVAPI32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function ClearEventLogW(
    hEventLog As IntPtr,   ' HANDLE
    <MarshalAs(UnmanagedType.LPWStr)> lpBackupFileName As String   ' LPCWSTR optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hEventLog : HANDLE
' lpBackupFileName : LPCWSTR optional
Declare PtrSafe Function ClearEventLogW Lib "advapi32" ( _
    ByVal hEventLog As LongPtr, _
    ByVal lpBackupFileName As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

ClearEventLogW = ctypes.windll.advapi32.ClearEventLogW
ClearEventLogW.restype = wintypes.BOOL
ClearEventLogW.argtypes = [
    wintypes.HANDLE,  # hEventLog : HANDLE
    wintypes.LPCWSTR,  # lpBackupFileName : LPCWSTR optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
ClearEventLogW = Fiddle::Function.new(
  lib['ClearEventLogW'],
  [
    Fiddle::TYPE_VOIDP,  # hEventLog : HANDLE
    Fiddle::TYPE_VOIDP,  # lpBackupFileName : LPCWSTR optional
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "advapi32")]
extern "system" {
    fn ClearEventLogW(
        hEventLog: *mut core::ffi::c_void,  // HANDLE
        lpBackupFileName: *const u16  // LPCWSTR optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool ClearEventLogW(IntPtr hEventLog, [MarshalAs(UnmanagedType.LPWStr)] string lpBackupFileName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_ClearEventLogW' -Namespace Win32 -PassThru
# $api::ClearEventLogW(hEventLog, lpBackupFileName)
#uselib "ADVAPI32.dll"
#func global ClearEventLogW "ClearEventLogW" wptr, wptr
; ClearEventLogW hEventLog, lpBackupFileName   ; 戻り値は stat
; hEventLog : HANDLE -> "wptr"
; lpBackupFileName : LPCWSTR optional -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "ADVAPI32.dll"
#cfunc global ClearEventLogW "ClearEventLogW" sptr, wstr
; res = ClearEventLogW(hEventLog, lpBackupFileName)
; hEventLog : HANDLE -> "sptr"
; lpBackupFileName : LPCWSTR optional -> "wstr"
; BOOL ClearEventLogW(HANDLE hEventLog, LPCWSTR lpBackupFileName)
#uselib "ADVAPI32.dll"
#cfunc global ClearEventLogW "ClearEventLogW" intptr, wstr
; res = ClearEventLogW(hEventLog, lpBackupFileName)
; hEventLog : HANDLE -> "intptr"
; lpBackupFileName : LPCWSTR optional -> "wstr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procClearEventLogW = advapi32.NewProc("ClearEventLogW")
)

// hEventLog (HANDLE), lpBackupFileName (LPCWSTR optional)
r1, _, err := procClearEventLogW.Call(
	uintptr(hEventLog),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpBackupFileName))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function ClearEventLogW(
  hEventLog: THandle;   // HANDLE
  lpBackupFileName: PWideChar   // LPCWSTR optional
): BOOL; stdcall;
  external 'ADVAPI32.dll' name 'ClearEventLogW';
result := DllCall("ADVAPI32\ClearEventLogW"
    , "Ptr", hEventLog   ; HANDLE
    , "WStr", lpBackupFileName   ; LPCWSTR optional
    , "Int")   ; return: BOOL
●ClearEventLogW(hEventLog, lpBackupFileName) = DLL("ADVAPI32.dll", "bool ClearEventLogW(void*, char*)")
# 呼び出し: ClearEventLogW(hEventLog, lpBackupFileName)
# hEventLog : HANDLE -> "void*"
# lpBackupFileName : LPCWSTR optional -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "advapi32" fn ClearEventLogW(
    hEventLog: ?*anyopaque, // HANDLE
    lpBackupFileName: [*c]const u16 // LPCWSTR optional
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc ClearEventLogW(
    hEventLog: pointer,  # HANDLE
    lpBackupFileName: WideCString  # LPCWSTR optional
): int32 {.importc: "ClearEventLogW", stdcall, dynlib: "ADVAPI32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "advapi32");
extern(Windows)
int ClearEventLogW(
    void* hEventLog,   // HANDLE
    const(wchar)* lpBackupFileName   // LPCWSTR optional
);
ccall((:ClearEventLogW, "ADVAPI32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Cwstring),
      hEventLog, lpBackupFileName)
# hEventLog : HANDLE -> Ptr{Cvoid}
# lpBackupFileName : LPCWSTR optional -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t ClearEventLogW(
    void* hEventLog,
    const uint16_t* lpBackupFileName);
]]
local advapi32 = ffi.load("advapi32")
-- advapi32.ClearEventLogW(hEventLog, lpBackupFileName)
-- hEventLog : HANDLE
-- lpBackupFileName : LPCWSTR optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('ADVAPI32.dll');
const ClearEventLogW = lib.func('__stdcall', 'ClearEventLogW', 'int32_t', ['void *', 'str16']);
// ClearEventLogW(hEventLog, lpBackupFileName)
// hEventLog : HANDLE -> 'void *'
// lpBackupFileName : LPCWSTR optional -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ADVAPI32.dll", {
  ClearEventLogW: { parameters: ["pointer", "buffer"], result: "i32" },
});
// lib.symbols.ClearEventLogW(hEventLog, lpBackupFileName)
// hEventLog : HANDLE -> "pointer"
// lpBackupFileName : LPCWSTR optional -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t ClearEventLogW(
    void* hEventLog,
    const uint16_t* lpBackupFileName);
C, "ADVAPI32.dll");
// $ffi->ClearEventLogW(hEventLog, lpBackupFileName);
// hEventLog : HANDLE
// lpBackupFileName : LPCWSTR optional
// 構造体/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 Advapi32 extends StdCallLibrary {
    Advapi32 INSTANCE = Native.load("advapi32", Advapi32.class, W32APIOptions.UNICODE_OPTIONS);
    boolean ClearEventLogW(
        Pointer hEventLog,   // HANDLE
        WString lpBackupFileName   // LPCWSTR optional
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("advapi32")]
lib LibADVAPI32
  fun ClearEventLogW = ClearEventLogW(
    hEventLog : Void*,   # HANDLE
    lpBackupFileName : UInt16*   # LPCWSTR optional
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef ClearEventLogWNative = Int32 Function(Pointer<Void>, Pointer<Utf16>);
typedef ClearEventLogWDart = int Function(Pointer<Void>, Pointer<Utf16>);
final ClearEventLogW = DynamicLibrary.open('ADVAPI32.dll')
    .lookupFunction<ClearEventLogWNative, ClearEventLogWDart>('ClearEventLogW');
// hEventLog : HANDLE -> Pointer<Void>
// lpBackupFileName : LPCWSTR optional -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ClearEventLogW(
  hEventLog: THandle;   // HANDLE
  lpBackupFileName: PWideChar   // LPCWSTR optional
): BOOL; stdcall;
  external 'ADVAPI32.dll' name 'ClearEventLogW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ClearEventLogW"
  c_ClearEventLogW :: Ptr () -> CWString -> IO CInt
-- hEventLog : HANDLE -> Ptr ()
-- lpBackupFileName : LPCWSTR optional -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let cleareventlogw =
  foreign "ClearEventLogW"
    ((ptr void) @-> (ptr uint16_t) @-> returning int32_t)
(* hEventLog : HANDLE -> (ptr void) *)
(* lpBackupFileName : LPCWSTR optional -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library advapi32 (t "ADVAPI32.dll"))
(cffi:use-foreign-library advapi32)

(cffi:defcfun ("ClearEventLogW" clear-event-log-w :convention :stdcall) :int32
  (h-event-log :pointer)   ; HANDLE
  (lp-backup-file-name (:string :encoding :utf-16le)))   ; LPCWSTR optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ClearEventLogW = Win32::API::More->new('ADVAPI32',
    'BOOL ClearEventLogW(HANDLE hEventLog, LPCWSTR lpBackupFileName)');
# my $ret = $ClearEventLogW->Call($hEventLog, $lpBackupFileName);
# hEventLog : HANDLE -> HANDLE
# lpBackupFileName : LPCWSTR optional -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
公式の関連項目