命名空间
变体
操作

std::filesystem::remove, std::filesystem::remove_all

来自 cppreference.cn
 
 
 
定义于头文件 <filesystem>
bool remove( const std::filesystem::path& p );
(1) (C++17 起)
bool remove( const std::filesystem::path& p, std::error_code& ec ) noexcept;
(2) (C++17 起)
std::uintmax_t remove_all( const std::filesystem::path& p );
(3) (C++17 起)
(4) (C++17 起)
1,2) 通过路径 p 标识的文件或空目录被删除,如同通过 POSIX remove。不跟踪符号链接(移除符号链接,而不是其目标)。
3,4) 删除 p 的内容(如果它是一个目录)及其所有子目录的内容,递归进行,然后删除 p 本身,如同通过重复应用 POSIX remove。不跟踪符号链接(移除符号链接,而不是其目标)。

目录

[编辑] 参数

p - 要删除的路径
ec - 用于在不抛出异常的重载中报告错误的输出参数。

[编辑] 返回值

1,2) 如果文件被删除则为 true,如果文件不存在则为 false。接受 error_code& 参数的重载在错误时返回 false
3,4) 返回被删除的文件和目录的数量(如果 p 最初不存在,则可能为零)。接受 error_code& 参数的重载在错误时返回 static_cast<std::uintmax_t>(-1)

[编辑] 异常

任何未标记为 noexcept 的重载都可能在内存分配失败时抛出 std::bad_alloc

1,3) 在底层 OS API 错误时抛出 std::filesystem::filesystem_error,构造时将 p 作为第一个路径参数,OS 错误码作为错误码参数。
2,4) 如果 OS API 调用失败,则将 std::error_code& 参数设置为 OS API 错误码;如果没有发生错误,则执行 ec.clear()

[编辑] 注意

在 POSIX 系统上,此函数通常会根据需要调用 unlinkrmdir,在 Windows 上调用 DeleteFileWRemoveDirectoryW

如果 p 不存在,此函数返回 false 且不报告错误。

[编辑] 示例

#include <cstdint>
#include <filesystem>
#include <fstream>
#include <iostream>
 
int main()
{
    namespace fs = std::filesystem;
    std::cout << std::boolalpha;
 
    fs::path tmp{std::filesystem::temp_directory_path()};
 
    const auto O_O{"O_O"};
    std::ofstream{tmp / O_O} << O_O; // creates file containing O_O
    std::cout << "remove(): " << fs::remove(tmp / O_O) << '\n'; // success
    std::cout << "remove(): " << fs::remove(tmp / O_O) << '\n'; // fail
 
    std::filesystem::create_directories(tmp / "abcdef/example");
    const std::uintmax_t n{fs::remove_all(tmp / "abcdef")};
    std::cout << "remove_all(): " << n << " files or directories\n";
}

可能的输出

remove(): true
remove(): false
remove_all(): 2 files or directories

[编辑] 缺陷报告

下列更改行为的缺陷报告追溯地应用于以前出版的 C++ 标准。

缺陷报告 应用于 发布时的行为 正确的行为
LWG 3014 C++17 remove_allerror_code 重载被标记为 noexcept 但可以分配内存 noexcept 已移除

[编辑] 参阅

擦除文件
(函数) [编辑]