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

RemoveDirectoryTransactedW

関数
トランザクション内で空のディレクトリを削除する(Unicode版)。
DLLKERNEL32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

BOOL RemoveDirectoryTransactedW(
    LPCWSTR lpPathName,
    HANDLE hTransaction
);

パラメーター

名前方向説明
lpPathNameLPCWSTRin

削除するディレクトリのパスです。パスには空のディレクトリを指定する必要があり、呼び出し元のプロセスはそのディレクトリに対する削除アクセス権を持っている必要があります。

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

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

ヒント

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

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

戻り値の型: BOOL

公式ドキュメント

既存の空のディレクトリをトランザクション操作として削除します。(Unicode)

戻り値

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

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

解説(Remarks)

RemoveDirectoryTransacted 関数は、ディレクトリをクローズ時に削除するようマークします。したがって、ディレクトリへの最後のハンドルがクローズされるまで、ディレクトリは削除されません。

RemoveDirectory は、ターゲットの内容が空でない場合でもディレクトリジャンクションを削除します。この関数は、ターゲットオブジェクトの状態に関係なくディレクトリジャンクションを削除します。

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 ヘッダーは RemoveDirectoryTransacted を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコーディング中立のエイリアスの使用と、エンコーディング中立でないコードを混在させると、コンパイルエラーや実行時エラーを引き起こす不一致が生じる可能性があります。詳細については、関数プロトタイプの規約 を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 RemoveDirectoryTransactedW(
    LPCWSTR lpPathName,
    HANDLE hTransaction
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool RemoveDirectoryTransactedW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpPathName,   // LPCWSTR
    IntPtr hTransaction   // HANDLE
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function RemoveDirectoryTransactedW(
    <MarshalAs(UnmanagedType.LPWStr)> lpPathName As String,   ' LPCWSTR
    hTransaction As IntPtr   ' HANDLE
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpPathName : LPCWSTR
' hTransaction : HANDLE
Declare PtrSafe Function RemoveDirectoryTransactedW Lib "kernel32" ( _
    ByVal lpPathName 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

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procRemoveDirectoryTransactedW = kernel32.NewProc("RemoveDirectoryTransactedW")
)

// lpPathName (LPCWSTR), hTransaction (HANDLE)
r1, _, err := procRemoveDirectoryTransactedW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpPathName))),
	uintptr(hTransaction),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function RemoveDirectoryTransactedW(
  lpPathName: PWideChar;   // LPCWSTR
  hTransaction: THandle   // HANDLE
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'RemoveDirectoryTransactedW';
result := DllCall("KERNEL32\RemoveDirectoryTransactedW"
    , "WStr", lpPathName   ; LPCWSTR
    , "Ptr", hTransaction   ; HANDLE
    , "Int")   ; return: BOOL
●RemoveDirectoryTransactedW(lpPathName, hTransaction) = DLL("KERNEL32.dll", "bool RemoveDirectoryTransactedW(char*, void*)")
# 呼び出し: RemoveDirectoryTransactedW(lpPathName, hTransaction)
# lpPathName : 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 RemoveDirectoryTransactedW(
    lpPathName: [*c]const u16, // LPCWSTR
    hTransaction: ?*anyopaque // HANDLE
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc RemoveDirectoryTransactedW(
    lpPathName: WideCString,  # LPCWSTR
    hTransaction: pointer  # HANDLE
): int32 {.importc: "RemoveDirectoryTransactedW", stdcall, dynlib: "KERNEL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "kernel32");
extern(Windows)
int RemoveDirectoryTransactedW(
    const(wchar)* lpPathName,   // LPCWSTR
    void* hTransaction   // HANDLE
);
ccall((:RemoveDirectoryTransactedW, "KERNEL32.dll"), stdcall, Int32,
      (Cwstring, Ptr{Cvoid}),
      lpPathName, hTransaction)
# lpPathName : LPCWSTR -> Cwstring
# hTransaction : HANDLE -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t RemoveDirectoryTransactedW(
    const uint16_t* lpPathName,
    void* hTransaction);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.RemoveDirectoryTransactedW(lpPathName, hTransaction)
-- lpPathName : 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 RemoveDirectoryTransactedW = lib.func('__stdcall', 'RemoveDirectoryTransactedW', 'int32_t', ['str16', 'void *']);
// RemoveDirectoryTransactedW(lpPathName, hTransaction)
// lpPathName : LPCWSTR -> 'str16'
// hTransaction : HANDLE -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  RemoveDirectoryTransactedW: { parameters: ["buffer", "pointer"], result: "i32" },
});
// lib.symbols.RemoveDirectoryTransactedW(lpPathName, hTransaction)
// lpPathName : 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 RemoveDirectoryTransactedW(
    const uint16_t* lpPathName,
    void* hTransaction);
C, "KERNEL32.dll");
// $ffi->RemoveDirectoryTransactedW(lpPathName, hTransaction);
// lpPathName : 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 RemoveDirectoryTransactedW(
        WString lpPathName,   // LPCWSTR
        Pointer hTransaction   // HANDLE
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("kernel32")]
lib LibKERNEL32
  fun RemoveDirectoryTransactedW = RemoveDirectoryTransactedW(
    lpPathName : 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 RemoveDirectoryTransactedWNative = Int32 Function(Pointer<Utf16>, Pointer<Void>);
typedef RemoveDirectoryTransactedWDart = int Function(Pointer<Utf16>, Pointer<Void>);
final RemoveDirectoryTransactedW = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<RemoveDirectoryTransactedWNative, RemoveDirectoryTransactedWDart>('RemoveDirectoryTransactedW');
// lpPathName : LPCWSTR -> Pointer<Utf16>
// hTransaction : HANDLE -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function RemoveDirectoryTransactedW(
  lpPathName: PWideChar;   // LPCWSTR
  hTransaction: THandle   // HANDLE
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'RemoveDirectoryTransactedW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let removedirectorytransactedw =
  foreign "RemoveDirectoryTransactedW"
    ((ptr uint16_t) @-> (ptr void) @-> returning int32_t)
(* lpPathName : 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 ("RemoveDirectoryTransactedW" remove-directory-transacted-w :convention :stdcall) :int32
  (lp-path-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 $RemoveDirectoryTransactedW = Win32::API::More->new('KERNEL32',
    'BOOL RemoveDirectoryTransactedW(LPCWSTR lpPathName, HANDLE hTransaction)');
# my $ret = $RemoveDirectoryTransactedW->Call($lpPathName, $hTransaction);
# lpPathName : LPCWSTR -> LPCWSTR
# hTransaction : HANDLE -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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