RemoveDirectoryTransactedA
関数シグネチャ
// KERNEL32.dll (ANSI / -A)
#include <windows.h>
BOOL RemoveDirectoryTransactedA(
LPCSTR lpPathName,
HANDLE hTransaction
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| lpPathName | LPCSTR | in | 削除するディレクトリのパス。パスには空のディレクトリを指定する必要があり、呼び出し元プロセスはそのディレクトリに対する削除アクセス権を持っている必要があります。 既定では、名前は MAX_PATH 文字に制限されます。この制限を 32,767 ワイド文字に拡張するには、パスの先頭に "\\?\" を付加します。詳細については、Naming Files, Paths, and Namespaces を参照してください。 ヒント
Windows 10 バージョン 1607 以降では、"\\?\" を付加しなくても MAX_PATH の制限を解除するようにオプトインできます。詳細については、Naming Files, Paths, and Namespaces の「Maximum Path Length Limitation」セクションを参照してください。 ディレクトリはローカルコンピューター上に存在する必要があります。そうでない場合、この関数は失敗し、最後のエラーコードは ERROR_TRANSACTIONS_UNSUPPORTED_REMOTE に設定されます。 |
| hTransaction | HANDLE | in | トランザクションへのハンドル。このハンドルは CreateTransaction 関数によって返されます。 |
戻り値の型: BOOL
公式ドキュメント
既存の空のディレクトリをトランザクション操作として削除します。(ANSI)
戻り値
関数が成功した場合、戻り値は 0 以外の値です。
関数が失敗した場合、戻り値は 0 です。詳細なエラー情報を取得するには、GetLastError を呼び出します。
解説(Remarks)
RemoveDirectoryTransacted 関数は、ディレクトリにクローズ時の削除のマークを付けます。したがって、ディレクトリはそのディレクトリへの最後のハンドルが閉じられるまで削除されません。
RemoveDirectory は、ターゲットの内容が空でない場合でもディレクトリジャンクションを削除します。この関数はターゲットオブジェクトの状態にかかわらずディレクトリジャンクションを削除します。
Windows 8 および Windows Server 2012 では、この関数は次のテクノロジでサポートされています。
| テクノロジ | サポート |
|---|---|
| Server Message Block (SMB) 3.0 プロトコル | いいえ |
| SMB 3.0 Transparent Failover (TFO) | いいえ |
| SMB 3.0 with Scale-out File Shares (SO) | いいえ |
| Cluster Shared Volume File System (CsvFS) | いいえ |
| Resilient File System (ReFS) | いいえ |
SMB 3.0 は TxF をサポートしていません。
winbase.h ヘッダーは RemoveDirectoryTransacted を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、コンパイルエラーや実行時エラーを引き起こす不一致が生じる可能性があります。詳細については、Conventions for Function Prototypes を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// KERNEL32.dll (ANSI / -A)
#include <windows.h>
BOOL RemoveDirectoryTransactedA(
LPCSTR lpPathName,
HANDLE hTransaction
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool RemoveDirectoryTransactedA(
[MarshalAs(UnmanagedType.LPStr)] string lpPathName, // LPCSTR
IntPtr hTransaction // HANDLE
);<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function RemoveDirectoryTransactedA(
<MarshalAs(UnmanagedType.LPStr)> lpPathName As String, ' LPCSTR
hTransaction As IntPtr ' HANDLE
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' lpPathName : LPCSTR
' hTransaction : HANDLE
Declare PtrSafe Function RemoveDirectoryTransactedA Lib "kernel32" ( _
ByVal lpPathName 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
RemoveDirectoryTransactedA = ctypes.windll.kernel32.RemoveDirectoryTransactedA
RemoveDirectoryTransactedA.restype = wintypes.BOOL
RemoveDirectoryTransactedA.argtypes = [
wintypes.LPCSTR, # lpPathName : 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')
RemoveDirectoryTransactedA = Fiddle::Function.new(
lib['RemoveDirectoryTransactedA'],
[
Fiddle::TYPE_VOIDP, # lpPathName : LPCSTR
Fiddle::TYPE_VOIDP, # hTransaction : HANDLE
],
Fiddle::TYPE_INT)#[link(name = "kernel32")]
extern "system" {
fn RemoveDirectoryTransactedA(
lpPathName: *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 RemoveDirectoryTransactedA([MarshalAs(UnmanagedType.LPStr)] string lpPathName, IntPtr hTransaction);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_RemoveDirectoryTransactedA' -Namespace Win32 -PassThru
# $api::RemoveDirectoryTransactedA(lpPathName, hTransaction)#uselib "KERNEL32.dll"
#func global RemoveDirectoryTransactedA "RemoveDirectoryTransactedA" sptr, sptr
; RemoveDirectoryTransactedA lpPathName, hTransaction ; 戻り値は stat
; lpPathName : LPCSTR -> "sptr"
; hTransaction : HANDLE -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "KERNEL32.dll"
#cfunc global RemoveDirectoryTransactedA "RemoveDirectoryTransactedA" str, sptr
; res = RemoveDirectoryTransactedA(lpPathName, hTransaction)
; lpPathName : LPCSTR -> "str"
; hTransaction : HANDLE -> "sptr"; BOOL RemoveDirectoryTransactedA(LPCSTR lpPathName, HANDLE hTransaction)
#uselib "KERNEL32.dll"
#cfunc global RemoveDirectoryTransactedA "RemoveDirectoryTransactedA" str, intptr
; res = RemoveDirectoryTransactedA(lpPathName, hTransaction)
; lpPathName : LPCSTR -> "str"
; hTransaction : HANDLE -> "intptr"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
procRemoveDirectoryTransactedA = kernel32.NewProc("RemoveDirectoryTransactedA")
)
// lpPathName (LPCSTR), hTransaction (HANDLE)
r1, _, err := procRemoveDirectoryTransactedA.Call(
uintptr(unsafe.Pointer(windows.BytePtrFromString(lpPathName))),
uintptr(hTransaction),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction RemoveDirectoryTransactedA(
lpPathName: PAnsiChar; // LPCSTR
hTransaction: THandle // HANDLE
): BOOL; stdcall;
external 'KERNEL32.dll' name 'RemoveDirectoryTransactedA';result := DllCall("KERNEL32\RemoveDirectoryTransactedA"
, "AStr", lpPathName ; LPCSTR
, "Ptr", hTransaction ; HANDLE
, "Int") ; return: BOOL●RemoveDirectoryTransactedA(lpPathName, hTransaction) = DLL("KERNEL32.dll", "bool RemoveDirectoryTransactedA(char*, void*)")
# 呼び出し: RemoveDirectoryTransactedA(lpPathName, hTransaction)
# lpPathName : LPCSTR -> "char*"
# hTransaction : HANDLE -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "kernel32" fn RemoveDirectoryTransactedA(
lpPathName: [*c]const u8, // LPCSTR
hTransaction: ?*anyopaque // HANDLE
) callconv(std.os.windows.WINAPI) i32;proc RemoveDirectoryTransactedA(
lpPathName: cstring, # LPCSTR
hTransaction: pointer # HANDLE
): int32 {.importc: "RemoveDirectoryTransactedA", stdcall, dynlib: "KERNEL32.dll".}pragma(lib, "kernel32");
extern(Windows)
int RemoveDirectoryTransactedA(
const(char)* lpPathName, // LPCSTR
void* hTransaction // HANDLE
);ccall((:RemoveDirectoryTransactedA, "KERNEL32.dll"), stdcall, Int32,
(Cstring, Ptr{Cvoid}),
lpPathName, hTransaction)
# lpPathName : LPCSTR -> Cstring
# hTransaction : HANDLE -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t RemoveDirectoryTransactedA(
const char* lpPathName,
void* hTransaction);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.RemoveDirectoryTransactedA(lpPathName, hTransaction)
-- lpPathName : LPCSTR
-- hTransaction : HANDLE
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const RemoveDirectoryTransactedA = lib.func('__stdcall', 'RemoveDirectoryTransactedA', 'int32_t', ['str', 'void *']);
// RemoveDirectoryTransactedA(lpPathName, hTransaction)
// lpPathName : LPCSTR -> 'str'
// hTransaction : HANDLE -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("KERNEL32.dll", {
RemoveDirectoryTransactedA: { parameters: ["buffer", "pointer"], result: "i32" },
});
// lib.symbols.RemoveDirectoryTransactedA(lpPathName, hTransaction)
// lpPathName : LPCSTR -> "buffer"
// hTransaction : HANDLE -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t RemoveDirectoryTransactedA(
const char* lpPathName,
void* hTransaction);
C, "KERNEL32.dll");
// $ffi->RemoveDirectoryTransactedA(lpPathName, hTransaction);
// lpPathName : 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 RemoveDirectoryTransactedA(
String lpPathName, // LPCSTR
Pointer hTransaction // HANDLE
);
}@[Link("kernel32")]
lib LibKERNEL32
fun RemoveDirectoryTransactedA = RemoveDirectoryTransactedA(
lpPathName : 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 RemoveDirectoryTransactedANative = Int32 Function(Pointer<Utf8>, Pointer<Void>);
typedef RemoveDirectoryTransactedADart = int Function(Pointer<Utf8>, Pointer<Void>);
final RemoveDirectoryTransactedA = DynamicLibrary.open('KERNEL32.dll')
.lookupFunction<RemoveDirectoryTransactedANative, RemoveDirectoryTransactedADart>('RemoveDirectoryTransactedA');
// lpPathName : LPCSTR -> Pointer<Utf8>
// hTransaction : HANDLE -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function RemoveDirectoryTransactedA(
lpPathName: PAnsiChar; // LPCSTR
hTransaction: THandle // HANDLE
): BOOL; stdcall;
external 'KERNEL32.dll' name 'RemoveDirectoryTransactedA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "RemoveDirectoryTransactedA"
c_RemoveDirectoryTransactedA :: CString -> Ptr () -> IO CInt
-- lpPathName : LPCSTR -> CString
-- hTransaction : HANDLE -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let removedirectorytransacteda =
foreign "RemoveDirectoryTransactedA"
(string @-> (ptr void) @-> returning int32_t)
(* lpPathName : 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 ("RemoveDirectoryTransactedA" remove-directory-transacted-a :convention :stdcall) :int32
(lp-path-name :string) ; LPCSTR
(h-transaction :pointer)) ; HANDLE
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $RemoveDirectoryTransactedA = Win32::API::More->new('KERNEL32',
'BOOL RemoveDirectoryTransactedA(LPCSTR lpPathName, HANDLE hTransaction)');
# my $ret = $RemoveDirectoryTransactedA->Call($lpPathName, $hTransaction);
# lpPathName : LPCSTR -> LPCSTR
# hTransaction : HANDLE -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f RemoveDirectoryTransactedW (Unicode版) — トランザクション内で空のディレクトリを削除する(Unicode版)。
- f CreateDirectoryTransactedA — トランザクション内でディレクトリを作成する(ANSI版)。