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

RemoveDirectoryW

関数
指定した空のディレクトリを削除する。
DLLKERNEL32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL RemoveDirectoryW(
    LPCWSTR lpPathName
);

パラメーター

名前方向説明
lpPathNameLPCWSTRin

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

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

ヒント

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

戻り値の型: BOOL

公式ドキュメント

既存の空のディレクトリを削除します。(Unicode)

戻り値

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

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

解説(Remarks)

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

ディレクトリ内のファイルを再帰的に削除するには、SHFileOperation 関数を使用します。

RemoveDirectory はディレクトリジャンクションの削除に使用できます。ターゲットディレクトリとその内容は正規のパスを通じて引き続きアクセス可能であるため、ターゲットディレクトリ自体は、それを指すジャンクションを削除しても影響を受けません。このため、lpPathName がディレクトリジャンクションを指している場合、RemoveDirectory は、ターゲットディレクトリが空であるかどうかにかかわらず、指定されたリンクを削除します。ジャンクションの詳細については、ハードリンクとジャンクションを参照してください。

POSIX 削除を使用すると、ハンドルが開いたままの状態でディレクトリが削除されます。その後にディレクトリを開くために CreateDirectory を呼び出すと、ERROR_FILE_NOT_FOUND で失敗します。

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

テクノロジ サポート
Server Message Block (SMB) 3.0 プロトコル あり
SMB 3.0 トランスペアレントフェールオーバー (TFO) あり
スケールアウトファイル共有 (SO) を使用した SMB 3.0 あり
クラスター共有ボリュームファイルシステム (CsvFS) あり
回復性のあるファイルシステム (ReFS) あり
メモ

fileapi.h ヘッダーは、RemoveDirectory を、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 RemoveDirectoryW(
    LPCWSTR lpPathName
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool RemoveDirectoryW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpPathName   // LPCWSTR
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function RemoveDirectoryW(
    <MarshalAs(UnmanagedType.LPWStr)> lpPathName As String   ' LPCWSTR
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpPathName : LPCWSTR
Declare PtrSafe Function RemoveDirectoryW Lib "kernel32" ( _
    ByVal lpPathName 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

RemoveDirectoryW = ctypes.windll.kernel32.RemoveDirectoryW
RemoveDirectoryW.restype = wintypes.BOOL
RemoveDirectoryW.argtypes = [
    wintypes.LPCWSTR,  # lpPathName : LPCWSTR
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procRemoveDirectoryW = kernel32.NewProc("RemoveDirectoryW")
)

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

extern "kernel32" fn RemoveDirectoryW(
    lpPathName: [*c]const u16 // LPCWSTR
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc RemoveDirectoryW(
    lpPathName: WideCString  # LPCWSTR
): int32 {.importc: "RemoveDirectoryW", stdcall, dynlib: "KERNEL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "kernel32");
extern(Windows)
int RemoveDirectoryW(
    const(wchar)* lpPathName   // LPCWSTR
);
ccall((:RemoveDirectoryW, "KERNEL32.dll"), stdcall, Int32,
      (Cwstring,),
      lpPathName)
# lpPathName : LPCWSTR -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t RemoveDirectoryW(
    const uint16_t* lpPathName);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.RemoveDirectoryW(lpPathName)
-- lpPathName : LPCWSTR
-- 構造体/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 RemoveDirectoryW = lib.func('__stdcall', 'RemoveDirectoryW', 'int32_t', ['str16']);
// RemoveDirectoryW(lpPathName)
// lpPathName : LPCWSTR -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  RemoveDirectoryW: { parameters: ["buffer"], result: "i32" },
});
// lib.symbols.RemoveDirectoryW(lpPathName)
// lpPathName : LPCWSTR -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t RemoveDirectoryW(
    const uint16_t* lpPathName);
C, "KERNEL32.dll");
// $ffi->RemoveDirectoryW(lpPathName);
// lpPathName : LPCWSTR
// 構造体/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 RemoveDirectoryW(
        WString lpPathName   // LPCWSTR
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("kernel32")]
lib LibKERNEL32
  fun RemoveDirectoryW = RemoveDirectoryW(
    lpPathName : UInt16*   # LPCWSTR
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef RemoveDirectoryWNative = Int32 Function(Pointer<Utf16>);
typedef RemoveDirectoryWDart = int Function(Pointer<Utf16>);
final RemoveDirectoryW = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<RemoveDirectoryWNative, RemoveDirectoryWDart>('RemoveDirectoryW');
// lpPathName : LPCWSTR -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function RemoveDirectoryW(
  lpPathName: PWideChar   // LPCWSTR
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'RemoveDirectoryW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let removedirectoryw =
  foreign "RemoveDirectoryW"
    ((ptr uint16_t) @-> returning int32_t)
(* lpPathName : LPCWSTR -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("RemoveDirectoryW" remove-directory-w :convention :stdcall) :int32
  (lp-path-name (:string :encoding :utf-16le)))   ; LPCWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $RemoveDirectoryW = Win32::API::More->new('KERNEL32',
    'BOOL RemoveDirectoryW(LPCWSTR lpPathName)');
# my $ret = $RemoveDirectoryW->Call($lpPathName);
# lpPathName : LPCWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
類似 API