RemoveDirectoryA 関数 (fileapi.h)

  • [アーティクル]

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

この操作をトランザクション操作として実行するには、 RemoveDirectoryTransacted 関数を使用します。

構文

BOOL RemoveDirectoryA(
  [in] LPCSTR lpPathName
);

パラメーター

[in] lpPathName

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

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

ヒント

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

戻り値

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

関数が失敗した場合は、0 を返します。 詳細なエラー情報を得るには、GetLastError を呼び出します。

解説

RemoveDirectory 関数は、終了時にディレクトリに削除のマークを付けます。 したがって、ディレクトリへの最後のハンドルが閉じられるまで、ディレクトリは削除されません。

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

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

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

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

テクノロジ サポートされています
サーバー メッセージ ブロック (SMB) 3.0 プロトコル はい
SMB 3.0 Transparent Failover (TFO) はい
スケールアウト ファイル共有 (SO) を使う SMB 3.0 はい
クラスターの共有ボリューム ファイル システム (CsvFS) はい
Resilient File System (ReFS) はい

注意

fileapi.h ヘッダーは、RemoveDirectory をエイリアスとして定義し、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択します。 エンコードに依存しないエイリアスをエンコードニュートラルでないコードと組み合わせて使用すると、コンパイルまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。

要件

要件 値
サポートされている最小のクライアント Windows XP [デスクトップ アプリ | UWP アプリ]
サポートされている最小のサーバー Windows Server 2003 [デスクトップ アプリのみ | UWP アプリ]
対象プラットフォーム Windows
ヘッダー fileapi.h (Windows.h を含む)
Library Kernel32.lib
[DLL] Kernel32.dll

関連項目

CreateDirectory

ディレクトリの作成と削除

ディレクトリ管理の関数

RemoveDirectoryTransacted