Namespaces
Variants

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

From cppreference.net
定义于头文件 <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 起)
(3) (C++17 起)
(4) (C++17 起)
1,2) 路径 p 所标识的文件或空目录将被删除,操作方式遵循 POSIX remove 规范。符号链接不会被解引用(删除的是符号链接本身而非其指向的目标)。
3,4) 删除 p (若为目录)及其所有子目录的递归内容,随后通过重复应用 POSIX remove 的方式删除 p 自身。不追踪符号链接(删除的是符号链接本身而非其目标)。

目录

参数

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) 当底层操作系统 API 出错时抛出 std::filesystem::filesystem_error ,该异常以 p 作为第一个路径参数,以操作系统错误代码作为错误码参数构造。
2,4) 若操作系统 API 调用失败,将 std:: error_code & 参数设置为操作系统 API 错误码;若无错误发生,则执行 ec. clear ( )

注释

在POSIX系统上,该函数通常根据需要调用 unlink rmdir ,在Windows系统上则调用 DeleteFileW RemoveDirectoryW

如果 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; // 创建包含 O_O 的文件
    std::cout << "remove(): " << fs::remove(tmp / O_O) << '\n'; // 成功
    std::cout << "remove(): " << fs::remove(tmp / O_O) << '\n'; // 失败
    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 error_code 重载的 remove_all 被标记为 noexcept 但可能分配内存 移除 noexcept

另请参阅

删除文件
(函数)