Win32 API 日本語リファレンス
ホームStorage.FileSystem › DeleteLogFile

DeleteLogFile

関数
指定名のCLFSログファイルを削除する。
DLLclfsw32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

BOOL DeleteLogFile(
    LPCWSTR pszLogFileName,
    void* pvReserved
);

パラメーター

名前方向説明
pszLogFileNameLPCWSTRin

ログの名前。

この名前は、CreateLogFile を使用してログを作成するときに指定します。次の例は、使用する形式を示しています。

log:<ログ名>[::<ログ ストリーム名>]

<ログ名> は、ファイル システム内の有効なファイル パスに対応します。

<ログ ストリーム名> は、ログ内のログ ストリームを一意に識別する名前です。

詳細については、「Log Types」を参照してください。

pvReservedvoid*inoutこのパラメーターは予約されており、NULL に設定する必要があります。

戻り値の型: BOOL

公式ドキュメント

ログに削除マークを付けます。ログが実際に削除されるのは、そのログに対するすべてのハンドル、マーシャリング領域、および読み取りコンテキストが閉じられたときです。ログが物理ログの場合は、その基盤となるコンテナーも削除されます。

戻り値

関数が成功した場合、戻り値は 0 以外の値です。

関数が失敗した場合、戻り値は 0 です。詳細なエラー情報を取得するには、GetLastError を呼び出します。次の一覧は、発生する可能性のあるエラー コードを示しています。

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

各言語での呼び出し定義

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

BOOL DeleteLogFile(
    LPCWSTR pszLogFileName,
    void* pvReserved
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("clfsw32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool DeleteLogFile(
    [MarshalAs(UnmanagedType.LPWStr)] string pszLogFileName,   // LPCWSTR
    IntPtr pvReserved   // void* in/out
);
<DllImport("clfsw32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function DeleteLogFile(
    <MarshalAs(UnmanagedType.LPWStr)> pszLogFileName As String,   ' LPCWSTR
    pvReserved As IntPtr   ' void* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' pszLogFileName : LPCWSTR
' pvReserved : void* in/out
Declare PtrSafe Function DeleteLogFile Lib "clfsw32" ( _
    ByVal pszLogFileName As LongPtr, _
    ByVal pvReserved As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

DeleteLogFile = ctypes.windll.clfsw32.DeleteLogFile
DeleteLogFile.restype = wintypes.BOOL
DeleteLogFile.argtypes = [
    wintypes.LPCWSTR,  # pszLogFileName : LPCWSTR
    ctypes.POINTER(None),  # pvReserved : void* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('clfsw32.dll')
DeleteLogFile = Fiddle::Function.new(
  lib['DeleteLogFile'],
  [
    Fiddle::TYPE_VOIDP,  # pszLogFileName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # pvReserved : void* in/out
  ],
  Fiddle::TYPE_INT)
#[link(name = "clfsw32")]
extern "system" {
    fn DeleteLogFile(
        pszLogFileName: *const u16,  // LPCWSTR
        pvReserved: *mut ()  // void* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("clfsw32.dll", SetLastError = true)]
public static extern bool DeleteLogFile([MarshalAs(UnmanagedType.LPWStr)] string pszLogFileName, IntPtr pvReserved);
"@
$api = Add-Type -MemberDefinition $sig -Name 'clfsw32_DeleteLogFile' -Namespace Win32 -PassThru
# $api::DeleteLogFile(pszLogFileName, pvReserved)
#uselib "clfsw32.dll"
#func global DeleteLogFile "DeleteLogFile" sptr, sptr
; DeleteLogFile pszLogFileName, pvReserved   ; 戻り値は stat
; pszLogFileName : LPCWSTR -> "sptr"
; pvReserved : void* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "clfsw32.dll"
#cfunc global DeleteLogFile "DeleteLogFile" wstr, sptr
; res = DeleteLogFile(pszLogFileName, pvReserved)
; pszLogFileName : LPCWSTR -> "wstr"
; pvReserved : void* in/out -> "sptr"
; BOOL DeleteLogFile(LPCWSTR pszLogFileName, void* pvReserved)
#uselib "clfsw32.dll"
#cfunc global DeleteLogFile "DeleteLogFile" wstr, intptr
; res = DeleteLogFile(pszLogFileName, pvReserved)
; pszLogFileName : LPCWSTR -> "wstr"
; pvReserved : void* in/out -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	clfsw32 = windows.NewLazySystemDLL("clfsw32.dll")
	procDeleteLogFile = clfsw32.NewProc("DeleteLogFile")
)

// pszLogFileName (LPCWSTR), pvReserved (void* in/out)
r1, _, err := procDeleteLogFile.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pszLogFileName))),
	uintptr(pvReserved),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function DeleteLogFile(
  pszLogFileName: PWideChar;   // LPCWSTR
  pvReserved: Pointer   // void* in/out
): BOOL; stdcall;
  external 'clfsw32.dll' name 'DeleteLogFile';
result := DllCall("clfsw32\DeleteLogFile"
    , "WStr", pszLogFileName   ; LPCWSTR
    , "Ptr", pvReserved   ; void* in/out
    , "Int")   ; return: BOOL
●DeleteLogFile(pszLogFileName, pvReserved) = DLL("clfsw32.dll", "bool DeleteLogFile(char*, void*)")
# 呼び出し: DeleteLogFile(pszLogFileName, pvReserved)
# pszLogFileName : LPCWSTR -> "char*"
# pvReserved : void* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "clfsw32" fn DeleteLogFile(
    pszLogFileName: [*c]const u16, // LPCWSTR
    pvReserved: ?*anyopaque // void* in/out
) callconv(std.os.windows.WINAPI) i32;
proc DeleteLogFile(
    pszLogFileName: WideCString,  # LPCWSTR
    pvReserved: pointer  # void* in/out
): int32 {.importc: "DeleteLogFile", stdcall, dynlib: "clfsw32.dll".}
pragma(lib, "clfsw32");
extern(Windows)
int DeleteLogFile(
    const(wchar)* pszLogFileName,   // LPCWSTR
    void* pvReserved   // void* in/out
);
ccall((:DeleteLogFile, "clfsw32.dll"), stdcall, Int32,
      (Cwstring, Ptr{Cvoid}),
      pszLogFileName, pvReserved)
# pszLogFileName : LPCWSTR -> Cwstring
# pvReserved : void* in/out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t DeleteLogFile(
    const uint16_t* pszLogFileName,
    void* pvReserved);
]]
local clfsw32 = ffi.load("clfsw32")
-- clfsw32.DeleteLogFile(pszLogFileName, pvReserved)
-- pszLogFileName : LPCWSTR
-- pvReserved : void* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('clfsw32.dll');
const DeleteLogFile = lib.func('__stdcall', 'DeleteLogFile', 'int32_t', ['str16', 'void *']);
// DeleteLogFile(pszLogFileName, pvReserved)
// pszLogFileName : LPCWSTR -> 'str16'
// pvReserved : void* in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("clfsw32.dll", {
  DeleteLogFile: { parameters: ["buffer", "pointer"], result: "i32" },
});
// lib.symbols.DeleteLogFile(pszLogFileName, pvReserved)
// pszLogFileName : LPCWSTR -> "buffer"
// pvReserved : void* in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t DeleteLogFile(
    const uint16_t* pszLogFileName,
    void* pvReserved);
C, "clfsw32.dll");
// $ffi->DeleteLogFile(pszLogFileName, pvReserved);
// pszLogFileName : LPCWSTR
// pvReserved : void* in/out
// 構造体/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 Clfsw32 extends StdCallLibrary {
    Clfsw32 INSTANCE = Native.load("clfsw32", Clfsw32.class);
    boolean DeleteLogFile(
        WString pszLogFileName,   // LPCWSTR
        Pointer pvReserved   // void* in/out
    );
}
@[Link("clfsw32")]
lib Libclfsw32
  fun DeleteLogFile = DeleteLogFile(
    pszLogFileName : UInt16*,   # LPCWSTR
    pvReserved : Void*   # void* in/out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef DeleteLogFileNative = Int32 Function(Pointer<Utf16>, Pointer<Void>);
typedef DeleteLogFileDart = int Function(Pointer<Utf16>, Pointer<Void>);
final DeleteLogFile = DynamicLibrary.open('clfsw32.dll')
    .lookupFunction<DeleteLogFileNative, DeleteLogFileDart>('DeleteLogFile');
// pszLogFileName : LPCWSTR -> Pointer<Utf16>
// pvReserved : void* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function DeleteLogFile(
  pszLogFileName: PWideChar;   // LPCWSTR
  pvReserved: Pointer   // void* in/out
): BOOL; stdcall;
  external 'clfsw32.dll' name 'DeleteLogFile';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "DeleteLogFile"
  c_DeleteLogFile :: CWString -> Ptr () -> IO CInt
-- pszLogFileName : LPCWSTR -> CWString
-- pvReserved : void* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let deletelogfile =
  foreign "DeleteLogFile"
    ((ptr uint16_t) @-> (ptr void) @-> returning int32_t)
(* pszLogFileName : LPCWSTR -> (ptr uint16_t) *)
(* pvReserved : void* in/out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library clfsw32 (t "clfsw32.dll"))
(cffi:use-foreign-library clfsw32)

(cffi:defcfun ("DeleteLogFile" delete-log-file :convention :stdcall) :int32
  (psz-log-file-name (:string :encoding :utf-16le))   ; LPCWSTR
  (pv-reserved :pointer))   ; void* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $DeleteLogFile = Win32::API::More->new('clfsw32',
    'BOOL DeleteLogFile(LPCWSTR pszLogFileName, LPVOID pvReserved)');
# my $ret = $DeleteLogFile->Call($pszLogFileName, $pvReserved);
# pszLogFileName : LPCWSTR -> LPCWSTR
# pvReserved : void* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目