DeleteFileA
関数シグネチャ
// KERNEL32.dll (ANSI / -A)
#include <windows.h>
BOOL DeleteFileA(
LPCSTR lpFileName
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| lpFileName | LPCSTR | in | 削除するファイルの名前です。 既定では、名前は MAX_PATH 文字に制限されます。この制限を 32,767 ワイド文字に拡張するには、パスの先頭に "\\?\" を付加します。詳細については、ファイル、パス、および名前空間の名前付けを参照してください。 ヒント
Windows 10 バージョン 1607 以降では、"\\?\" を付加せずに MAX_PATH の制限を解除することにオプトインできます。詳細については、ファイル、パス、および名前空間の名前付けの「最大パス長の制限」セクションを参照してください。 |
戻り値の型: BOOL
公式ドキュメント
既存のファイルを削除します。(DeleteFileA)
戻り値
関数が成功した場合、戻り値は 0 以外の値です。
関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、GetLastError を呼び出します。
解説(Remarks)
アプリケーションが存在しないファイルを削除しようとした場合、DeleteFile 関数は ERROR_FILE_NOT_FOUND で失敗します。ファイルが読み取り専用ファイルである場合、関数は ERROR_ACCESS_DENIED で失敗します。
次の一覧は、ファイルの削除、除去、またはクローズに関するいくつかのヒントを示しています。
- 読み取り専用ファイルを削除するには、まず読み取り専用属性を解除する必要があります。
- ファイルを削除または名前変更するには、そのファイルに対する削除権限、または親ディレクトリに対する子の削除権限のいずれかが必要です。
- ディレクトリ内のファイルを再帰的に削除するには、SHFileOperation 関数を使用します。
- 空のディレクトリを除去するには、RemoveDirectory 関数を使用します。
- 開いているファイルをクローズするには、CloseHandle 関数を使用します。
削除および子の削除を除くすべてのアクセスを持つディレクトリを設定し、新しいファイルのアクセス制御リスト (ACL) が継承される場合、ファイルを作成できても削除できない状態になることがあります。ただしその場合でも、ファイルを作成し、ファイルの作成時に返されたハンドルに対して要求したすべてのアクセス権を取得できます。
ファイルの作成時に削除権限を要求すると、そのハンドルを使用してファイルを削除または名前変更できますが、他のハンドルでは行えません。詳細については、ファイルのセキュリティとアクセス権を参照してください。
アプリケーションが、通常の I/O 用またはメモリマップトファイルとして他のハンドルが開かれているファイルを削除しようとした場合、DeleteFile 関数は失敗します(他のハンドルを開いたときに FILE_SHARE_DELETE が指定されている必要があります)。
DeleteFile 関数は、クローズ時に削除するようにファイルをマークします。したがって、ファイルへの最後のハンドルがクローズされるまでファイルの削除は行われません。ファイルを開くための CreateFile の後続の呼び出しは、ERROR_ACCESS_DENIED で失敗します。
POSIX 削除を使用すると、ハンドルが開いたままの状態でファイルが削除されます。ファイルを開くための CreateFile の後続の呼び出しは、ERROR_FILE_NOT_FOUND で失敗します。
シンボリックリンクの動作:
パスがシンボリックリンクを指している場合、ターゲットではなくシンボリックリンクが削除されます。ターゲットを削除するには、CreateFile を呼び出して FILE_FLAG_DELETE_ON_CLOSE を指定する必要があります。
Windows 8 および Windows Server 2012 では、この関数は次のテクノロジによってサポートされています。
| テクノロジ | サポート |
|---|---|
| Server Message Block (SMB) 3.0 プロトコル | はい |
| SMB 3.0 透過的フェールオーバー (TFO) | はい |
| スケールアウトファイル共有 (SO) を使用した SMB 3.0 | はい |
| クラスター共有ボリュームファイルシステム (CsvFS) | はい |
| 回復性ファイルシステム (ReFS) | はい |
例
例については、ファイル内のバイト範囲のロックとロック解除を参照してください。
fileapi.h ヘッダーは DeleteFile を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコーディング非依存のエイリアスを、エンコーディング非依存でないコードと混在して使用すると、不一致が生じてコンパイルエラーまたは実行時エラーが発生する可能性があります。詳細については、関数プロトタイプの規則を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// KERNEL32.dll (ANSI / -A)
#include <windows.h>
BOOL DeleteFileA(
LPCSTR lpFileName
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool DeleteFileA(
[MarshalAs(UnmanagedType.LPStr)] string lpFileName // LPCSTR
);<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function DeleteFileA(
<MarshalAs(UnmanagedType.LPStr)> lpFileName As String ' LPCSTR
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' lpFileName : LPCSTR
Declare PtrSafe Function DeleteFileA Lib "kernel32" ( _
ByVal lpFileName As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
DeleteFileA = ctypes.windll.kernel32.DeleteFileA
DeleteFileA.restype = wintypes.BOOL
DeleteFileA.argtypes = [
wintypes.LPCSTR, # lpFileName : LPCSTR
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('KERNEL32.dll')
DeleteFileA = Fiddle::Function.new(
lib['DeleteFileA'],
[
Fiddle::TYPE_VOIDP, # lpFileName : LPCSTR
],
Fiddle::TYPE_INT)#[link(name = "kernel32")]
extern "system" {
fn DeleteFileA(
lpFileName: *const u8 // LPCSTR
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool DeleteFileA([MarshalAs(UnmanagedType.LPStr)] string lpFileName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_DeleteFileA' -Namespace Win32 -PassThru
# $api::DeleteFileA(lpFileName)#uselib "KERNEL32.dll"
#func global DeleteFileA "DeleteFileA" sptr
; DeleteFileA lpFileName ; 戻り値は stat
; lpFileName : LPCSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "KERNEL32.dll"
#cfunc global DeleteFileA "DeleteFileA" str
; res = DeleteFileA(lpFileName)
; lpFileName : LPCSTR -> "str"; BOOL DeleteFileA(LPCSTR lpFileName)
#uselib "KERNEL32.dll"
#cfunc global DeleteFileA "DeleteFileA" str
; res = DeleteFileA(lpFileName)
; lpFileName : LPCSTR -> "str"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
procDeleteFileA = kernel32.NewProc("DeleteFileA")
)
// lpFileName (LPCSTR)
r1, _, err := procDeleteFileA.Call(
uintptr(unsafe.Pointer(windows.BytePtrFromString(lpFileName))),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction DeleteFileA(
lpFileName: PAnsiChar // LPCSTR
): BOOL; stdcall;
external 'KERNEL32.dll' name 'DeleteFileA';result := DllCall("KERNEL32\DeleteFileA"
, "AStr", lpFileName ; LPCSTR
, "Int") ; return: BOOL●DeleteFileA(lpFileName) = DLL("KERNEL32.dll", "bool DeleteFileA(char*)")
# 呼び出し: DeleteFileA(lpFileName)
# lpFileName : LPCSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "kernel32" fn DeleteFileA(
lpFileName: [*c]const u8 // LPCSTR
) callconv(std.os.windows.WINAPI) i32;proc DeleteFileA(
lpFileName: cstring # LPCSTR
): int32 {.importc: "DeleteFileA", stdcall, dynlib: "KERNEL32.dll".}pragma(lib, "kernel32");
extern(Windows)
int DeleteFileA(
const(char)* lpFileName // LPCSTR
);ccall((:DeleteFileA, "KERNEL32.dll"), stdcall, Int32,
(Cstring,),
lpFileName)
# lpFileName : LPCSTR -> Cstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t DeleteFileA(
const char* lpFileName);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.DeleteFileA(lpFileName)
-- lpFileName : LPCSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const DeleteFileA = lib.func('__stdcall', 'DeleteFileA', 'int32_t', ['str']);
// DeleteFileA(lpFileName)
// lpFileName : LPCSTR -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("KERNEL32.dll", {
DeleteFileA: { parameters: ["buffer"], result: "i32" },
});
// lib.symbols.DeleteFileA(lpFileName)
// lpFileName : LPCSTR -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t DeleteFileA(
const char* lpFileName);
C, "KERNEL32.dll");
// $ffi->DeleteFileA(lpFileName);
// lpFileName : LPCSTR
// 構造体/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 Kernel32 extends StdCallLibrary {
Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class, W32APIOptions.ASCII_OPTIONS);
boolean DeleteFileA(
String lpFileName // LPCSTR
);
}@[Link("kernel32")]
lib LibKERNEL32
fun DeleteFileA = DeleteFileA(
lpFileName : UInt8* # LPCSTR
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef DeleteFileANative = Int32 Function(Pointer<Utf8>);
typedef DeleteFileADart = int Function(Pointer<Utf8>);
final DeleteFileA = DynamicLibrary.open('KERNEL32.dll')
.lookupFunction<DeleteFileANative, DeleteFileADart>('DeleteFileA');
// lpFileName : LPCSTR -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function DeleteFileA(
lpFileName: PAnsiChar // LPCSTR
): BOOL; stdcall;
external 'KERNEL32.dll' name 'DeleteFileA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "DeleteFileA"
c_DeleteFileA :: CString -> IO CInt
-- lpFileName : LPCSTR -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let deletefilea =
foreign "DeleteFileA"
(string @-> returning int32_t)
(* lpFileName : LPCSTR -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)
(cffi:defcfun ("DeleteFileA" delete-file-a :convention :stdcall) :int32
(lp-file-name :string)) ; LPCSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $DeleteFileA = Win32::API::More->new('KERNEL32',
'BOOL DeleteFileA(LPCSTR lpFileName)');
# my $ret = $DeleteFileA->Call($lpFileName);
# lpFileName : LPCSTR -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f DeleteFileW (Unicode版) — 指定したファイルを削除する。
- f DeleteFile2A — フラグを指定してファイルを削除する(ANSI版)。