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

DeleteFileTransactedA

関数
トランザクション内で指定ファイルを削除する(ANSI版)。
DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

BOOL DeleteFileTransactedA(
    LPCSTR lpFileName,
    HANDLE hTransaction
);

パラメーター

名前方向説明
lpFileNameLPCSTRin

削除するファイルの名前です。

既定では、名前は MAX_PATH 文字に制限されます。この制限を 32,767 ワイド文字に拡張するには、パスの先頭に "\\?\" を付加します。詳細については、ファイル、パス、名前空間の名前付けを参照してください。

ヒント

Windows 10 バージョン 1607 以降では、"\\?\" を付加せずに MAX_PATH 制限を解除するようオプトインできます。詳細については、ファイル、パス、名前空間の名前付けの「最大パス長の制限」セクションを参照してください。

ファイルはローカルコンピューター上に存在している必要があります。そうでない場合、この関数は失敗し、最後のエラーコードは ERROR_TRANSACTIONS_UNSUPPORTED_REMOTE に設定されます。

hTransactionHANDLEinトランザクションへのハンドルです。このハンドルは CreateTransaction 関数によって返されます。

戻り値の型: BOOL

公式ドキュメント

既存のファイルをトランザクション操作として削除します。(ANSI)

戻り値

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

関数が失敗すると、戻り値は 0 (ゼロ) になります。拡張エラー情報を取得するには、 GetLastError を呼び出します。

解説(Remarks)

アプリケーションが存在しないファイルを削除しようとすると、 DeleteFileTransacted 関数は ERROR_FILE_NOT_FOUND で失敗します。ファイルが読み取り専用ファイルである場合、この関数は ERROR_ACCESS_DENIED で失敗します。

次の一覧は、ファイルの削除、除去、またはクローズに関するいくつかのヒントを示しています。

削除および子の削除を除くすべてのアクセスを持つディレクトリを設定し、新しいファイルのアクセス制御リスト (ACL) が継承される場合、ファイルを作成できても削除できないという状態になり得ます。ただし、その場合でもファイルを作成し、ファイル作成時に返されるハンドルに対して要求したすべてのアクセスを取得できます。

ファイル作成時に削除権限を要求した場合、そのハンドルでファイルを削除または名前変更できますが、他のハンドルでは行えません。詳細については、 ファイルのセキュリティとアクセス権を参照してください。

DeleteFileTransacted 関数は、通常の I/O 用またはメモリマップトファイルとして他のハンドルが開かれているファイルをアプリケーションが削除しようとした場合に失敗します (他のハンドルが開かれた際に FILE_SHARE_DELETE が指定されている必要があります)。

DeleteFileTransacted 関数は、ファイルにクローズ時の削除のマークを付けます。ファイルは、トランザクションがまだアクティブであることを条件として、ファイルに対する最後のトランザクション書き込みハンドルがクローズされた後に削除されます。ファイルに削除のマークが付けられ、トランザクションの完了後もトランザクション書き込みハンドルが開いたままになっている場合、ファイルは削除されません。

シンボリックリンク: パスがシンボリックリンクを指している場合、ターゲットではなくシンボリックリンクが削除されます。ターゲットを削除するには、 CreateFile を呼び出して FILE_FLAG_DELETE_ON_CLOSE を指定する必要があります。

Windows 8 および Windows Server 2012 では、この関数は次のテクノロジによってサポートされます。

テクノロジ サポート
Server Message Block (SMB) 3.0 プロトコル いいえ
SMB 3.0 透過的フェールオーバー (TFO) いいえ
スケールアウトファイル共有を備えた SMB 3.0 (SO) いいえ
クラスター共有ボリュームファイルシステム (CsvFS) いいえ
回復性ファイルシステム (ReFS) いいえ

SMB 3.0 は TxF をサポートしていません。

メモ

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

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

各言語での呼び出し定義

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

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

DeleteFileTransactedA = ctypes.windll.kernel32.DeleteFileTransactedA
DeleteFileTransactedA.restype = wintypes.BOOL
DeleteFileTransactedA.argtypes = [
    wintypes.LPCSTR,  # lpFileName : LPCSTR
    wintypes.HANDLE,  # hTransaction : HANDLE
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
DeleteFileTransactedA = Fiddle::Function.new(
  lib['DeleteFileTransactedA'],
  [
    Fiddle::TYPE_VOIDP,  # lpFileName : LPCSTR
    Fiddle::TYPE_VOIDP,  # hTransaction : HANDLE
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn DeleteFileTransactedA(
        lpFileName: *const u8,  // LPCSTR
        hTransaction: *mut core::ffi::c_void  // HANDLE
    ) -> 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 DeleteFileTransactedA([MarshalAs(UnmanagedType.LPStr)] string lpFileName, IntPtr hTransaction);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_DeleteFileTransactedA' -Namespace Win32 -PassThru
# $api::DeleteFileTransactedA(lpFileName, hTransaction)
#uselib "KERNEL32.dll"
#func global DeleteFileTransactedA "DeleteFileTransactedA" sptr, sptr
; DeleteFileTransactedA lpFileName, hTransaction   ; 戻り値は stat
; lpFileName : LPCSTR -> "sptr"
; hTransaction : HANDLE -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global DeleteFileTransactedA "DeleteFileTransactedA" str, sptr
; res = DeleteFileTransactedA(lpFileName, hTransaction)
; lpFileName : LPCSTR -> "str"
; hTransaction : HANDLE -> "sptr"
; BOOL DeleteFileTransactedA(LPCSTR lpFileName, HANDLE hTransaction)
#uselib "KERNEL32.dll"
#cfunc global DeleteFileTransactedA "DeleteFileTransactedA" str, intptr
; res = DeleteFileTransactedA(lpFileName, hTransaction)
; lpFileName : LPCSTR -> "str"
; hTransaction : HANDLE -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procDeleteFileTransactedA = kernel32.NewProc("DeleteFileTransactedA")
)

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

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

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

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

let deletefiletransacteda =
  foreign "DeleteFileTransactedA"
    (string @-> (ptr void) @-> returning int32_t)
(* lpFileName : LPCSTR -> string *)
(* hTransaction : HANDLE -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

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

関連項目

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