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

ClearEventLogA

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

シグネチャ

// ADVAPI32.dll  (ANSI / -A)
#include <windows.h>

BOOL ClearEventLogA(
    HANDLE hEventLog,
    LPCSTR lpBackupFileName   // optional
);

パラメーター

名前方向説明
hEventLogHANDLEinクリアするイベントログのハンドル。このハンドルは OpenEventLog 関数によって返されます。
lpBackupFileNameLPCSTRinoptional

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

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

戻り値の型: BOOL

公式ドキュメント

指定したイベントログをクリアし、必要に応じてログの現在のコピーをバックアップファイルに保存します。(ANSI)

戻り値

関数が成功した場合、戻り値は 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  (ANSI / -A)
#include <windows.h>

BOOL ClearEventLogA(
    HANDLE hEventLog,
    LPCSTR lpBackupFileName   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool ClearEventLogA(
    IntPtr hEventLog,   // HANDLE
    [MarshalAs(UnmanagedType.LPStr)] string lpBackupFileName   // LPCSTR optional
);
<DllImport("ADVAPI32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function ClearEventLogA(
    hEventLog As IntPtr,   ' HANDLE
    <MarshalAs(UnmanagedType.LPStr)> lpBackupFileName As String   ' LPCSTR optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hEventLog : HANDLE
' lpBackupFileName : LPCSTR optional
Declare PtrSafe Function ClearEventLogA Lib "advapi32" ( _
    ByVal hEventLog As LongPtr, _
    ByVal lpBackupFileName As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

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

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

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procClearEventLogA = advapi32.NewProc("ClearEventLogA")
)

// hEventLog (HANDLE), lpBackupFileName (LPCSTR optional)
r1, _, err := procClearEventLogA.Call(
	uintptr(hEventLog),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpBackupFileName))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function ClearEventLogA(
  hEventLog: THandle;   // HANDLE
  lpBackupFileName: PAnsiChar   // LPCSTR optional
): BOOL; stdcall;
  external 'ADVAPI32.dll' name 'ClearEventLogA';
result := DllCall("ADVAPI32\ClearEventLogA"
    , "Ptr", hEventLog   ; HANDLE
    , "AStr", lpBackupFileName   ; LPCSTR optional
    , "Int")   ; return: BOOL
●ClearEventLogA(hEventLog, lpBackupFileName) = DLL("ADVAPI32.dll", "bool ClearEventLogA(void*, char*)")
# 呼び出し: ClearEventLogA(hEventLog, lpBackupFileName)
# hEventLog : HANDLE -> "void*"
# lpBackupFileName : LPCSTR optional -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "advapi32" fn ClearEventLogA(
    hEventLog: ?*anyopaque, // HANDLE
    lpBackupFileName: [*c]const u8 // LPCSTR optional
) callconv(std.os.windows.WINAPI) i32;
proc ClearEventLogA(
    hEventLog: pointer,  # HANDLE
    lpBackupFileName: cstring  # LPCSTR optional
): int32 {.importc: "ClearEventLogA", stdcall, dynlib: "ADVAPI32.dll".}
pragma(lib, "advapi32");
extern(Windows)
int ClearEventLogA(
    void* hEventLog,   // HANDLE
    const(char)* lpBackupFileName   // LPCSTR optional
);
ccall((:ClearEventLogA, "ADVAPI32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Cstring),
      hEventLog, lpBackupFileName)
# hEventLog : HANDLE -> Ptr{Cvoid}
# lpBackupFileName : LPCSTR optional -> Cstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t ClearEventLogA(
    void* hEventLog,
    const char* lpBackupFileName);
]]
local advapi32 = ffi.load("advapi32")
-- advapi32.ClearEventLogA(hEventLog, lpBackupFileName)
-- hEventLog : HANDLE
-- lpBackupFileName : LPCSTR optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('ADVAPI32.dll');
const ClearEventLogA = lib.func('__stdcall', 'ClearEventLogA', 'int32_t', ['void *', 'str']);
// ClearEventLogA(hEventLog, lpBackupFileName)
// hEventLog : HANDLE -> 'void *'
// lpBackupFileName : LPCSTR optional -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ADVAPI32.dll", {
  ClearEventLogA: { parameters: ["pointer", "buffer"], result: "i32" },
});
// lib.symbols.ClearEventLogA(hEventLog, lpBackupFileName)
// hEventLog : HANDLE -> "pointer"
// lpBackupFileName : LPCSTR optional -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t ClearEventLogA(
    void* hEventLog,
    const char* lpBackupFileName);
C, "ADVAPI32.dll");
// $ffi->ClearEventLogA(hEventLog, lpBackupFileName);
// hEventLog : HANDLE
// lpBackupFileName : LPCSTR 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.ASCII_OPTIONS);
    boolean ClearEventLogA(
        Pointer hEventLog,   // HANDLE
        String lpBackupFileName   // LPCSTR optional
    );
}
@[Link("advapi32")]
lib LibADVAPI32
  fun ClearEventLogA = ClearEventLogA(
    hEventLog : Void*,   # HANDLE
    lpBackupFileName : UInt8*   # LPCSTR optional
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

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

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

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

(cffi:defcfun ("ClearEventLogA" clear-event-log-a :convention :stdcall) :int32
  (h-event-log :pointer)   ; HANDLE
  (lp-backup-file-name :string))   ; LPCSTR optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ClearEventLogA = Win32::API::More->new('ADVAPI32',
    'BOOL ClearEventLogA(HANDLE hEventLog, LPCSTR lpBackupFileName)');
# my $ret = $ClearEventLogA->Call($hEventLog, $lpBackupFileName);
# hEventLog : HANDLE -> HANDLE
# lpBackupFileName : LPCSTR optional -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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