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

DeleteFileTransactedW

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

シグネチャ

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

BOOL DeleteFileTransactedW(
    LPCWSTR lpFileName,
    HANDLE hTransaction
);

パラメーター

名前方向説明
lpFileNameLPCWSTRin

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

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

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

ヒント

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

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

戻り値の型: BOOL

公式ドキュメント

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

戻り値

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

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

解説(Remarks)

存在しないファイルを削除しようとすると、 DeleteFileTransacted 関数は ERROR_FILE_NOT_FOUND で失敗します。ファイルが読み取り専用ファイルの場合、関数は ERROR_ACCESS_DENIED で失敗します。

以下のリストは、ファイルの削除、除去、またはクローズに関するいくつかのヒントを示します。

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

ファイル作成時に削除アクセス許可を要求した場合、そのハンドルでファイルを削除または名前変更できますが、他のハンドルではできません。詳細については、 File Security and Access Rights を参照してください。

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) いいえ
スケールアウトファイル共有 (SO) を使用する SMB 3.0 いいえ
クラスター共有ボリュームファイルシステム (CsvFS) いいえ
回復性のあるファイルシステム (ReFS) いいえ

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

メモ

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

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

各言語での呼び出し定義

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

BOOL DeleteFileTransactedW(
    LPCWSTR lpFileName,
    HANDLE hTransaction
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool DeleteFileTransactedW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpFileName,   // LPCWSTR
    IntPtr hTransaction   // HANDLE
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function DeleteFileTransactedW(
    <MarshalAs(UnmanagedType.LPWStr)> lpFileName As String,   ' LPCWSTR
    hTransaction As IntPtr   ' HANDLE
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpFileName : LPCWSTR
' hTransaction : HANDLE
Declare PtrSafe Function DeleteFileTransactedW Lib "kernel32" ( _
    ByVal lpFileName As LongPtr, _
    ByVal hTransaction 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

DeleteFileTransactedW = ctypes.windll.kernel32.DeleteFileTransactedW
DeleteFileTransactedW.restype = wintypes.BOOL
DeleteFileTransactedW.argtypes = [
    wintypes.LPCWSTR,  # lpFileName : LPCWSTR
    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')
DeleteFileTransactedW = Fiddle::Function.new(
  lib['DeleteFileTransactedW'],
  [
    Fiddle::TYPE_VOIDP,  # lpFileName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # hTransaction : HANDLE
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "kernel32")]
extern "system" {
    fn DeleteFileTransactedW(
        lpFileName: *const u16,  // LPCWSTR
        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.Unicode, SetLastError = true)]
public static extern bool DeleteFileTransactedW([MarshalAs(UnmanagedType.LPWStr)] string lpFileName, IntPtr hTransaction);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_DeleteFileTransactedW' -Namespace Win32 -PassThru
# $api::DeleteFileTransactedW(lpFileName, hTransaction)
#uselib "KERNEL32.dll"
#func global DeleteFileTransactedW "DeleteFileTransactedW" wptr, wptr
; DeleteFileTransactedW lpFileName, hTransaction   ; 戻り値は stat
; lpFileName : LPCWSTR -> "wptr"
; hTransaction : HANDLE -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global DeleteFileTransactedW "DeleteFileTransactedW" wstr, sptr
; res = DeleteFileTransactedW(lpFileName, hTransaction)
; lpFileName : LPCWSTR -> "wstr"
; hTransaction : HANDLE -> "sptr"
; BOOL DeleteFileTransactedW(LPCWSTR lpFileName, HANDLE hTransaction)
#uselib "KERNEL32.dll"
#cfunc global DeleteFileTransactedW "DeleteFileTransactedW" wstr, intptr
; res = DeleteFileTransactedW(lpFileName, hTransaction)
; lpFileName : LPCWSTR -> "wstr"
; hTransaction : HANDLE -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procDeleteFileTransactedW = kernel32.NewProc("DeleteFileTransactedW")
)

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

extern "kernel32" fn DeleteFileTransactedW(
    lpFileName: [*c]const u16, // LPCWSTR
    hTransaction: ?*anyopaque // HANDLE
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc DeleteFileTransactedW(
    lpFileName: WideCString,  # LPCWSTR
    hTransaction: pointer  # HANDLE
): int32 {.importc: "DeleteFileTransactedW", stdcall, dynlib: "KERNEL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "kernel32");
extern(Windows)
int DeleteFileTransactedW(
    const(wchar)* lpFileName,   // LPCWSTR
    void* hTransaction   // HANDLE
);
ccall((:DeleteFileTransactedW, "KERNEL32.dll"), stdcall, Int32,
      (Cwstring, Ptr{Cvoid}),
      lpFileName, hTransaction)
# lpFileName : LPCWSTR -> Cwstring
# hTransaction : HANDLE -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t DeleteFileTransactedW(
    const uint16_t* lpFileName,
    void* hTransaction);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.DeleteFileTransactedW(lpFileName, hTransaction)
-- lpFileName : LPCWSTR
-- hTransaction : HANDLE
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const DeleteFileTransactedW = lib.func('__stdcall', 'DeleteFileTransactedW', 'int32_t', ['str16', 'void *']);
// DeleteFileTransactedW(lpFileName, hTransaction)
// lpFileName : LPCWSTR -> 'str16'
// hTransaction : HANDLE -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  DeleteFileTransactedW: { parameters: ["buffer", "pointer"], result: "i32" },
});
// lib.symbols.DeleteFileTransactedW(lpFileName, hTransaction)
// lpFileName : LPCWSTR -> "buffer"
// hTransaction : HANDLE -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t DeleteFileTransactedW(
    const uint16_t* lpFileName,
    void* hTransaction);
C, "KERNEL32.dll");
// $ffi->DeleteFileTransactedW(lpFileName, hTransaction);
// lpFileName : LPCWSTR
// 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.UNICODE_OPTIONS);
    boolean DeleteFileTransactedW(
        WString lpFileName,   // LPCWSTR
        Pointer hTransaction   // HANDLE
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("kernel32")]
lib LibKERNEL32
  fun DeleteFileTransactedW = DeleteFileTransactedW(
    lpFileName : UInt16*,   # LPCWSTR
    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 DeleteFileTransactedWNative = Int32 Function(Pointer<Utf16>, Pointer<Void>);
typedef DeleteFileTransactedWDart = int Function(Pointer<Utf16>, Pointer<Void>);
final DeleteFileTransactedW = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<DeleteFileTransactedWNative, DeleteFileTransactedWDart>('DeleteFileTransactedW');
// lpFileName : LPCWSTR -> Pointer<Utf16>
// hTransaction : HANDLE -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function DeleteFileTransactedW(
  lpFileName: PWideChar;   // LPCWSTR
  hTransaction: THandle   // HANDLE
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'DeleteFileTransactedW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let deletefiletransactedw =
  foreign "DeleteFileTransactedW"
    ((ptr uint16_t) @-> (ptr void) @-> returning int32_t)
(* lpFileName : LPCWSTR -> (ptr uint16_t) *)
(* 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 ("DeleteFileTransactedW" delete-file-transacted-w :convention :stdcall) :int32
  (lp-file-name (:string :encoding :utf-16le))   ; LPCWSTR
  (h-transaction :pointer))   ; HANDLE
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $DeleteFileTransactedW = Win32::API::More->new('KERNEL32',
    'BOOL DeleteFileTransactedW(LPCWSTR lpFileName, HANDLE hTransaction)');
# my $ret = $DeleteFileTransactedW->Call($lpFileName, $hTransaction);
# lpFileName : LPCWSTR -> LPCWSTR
# hTransaction : HANDLE -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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