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

来自cppreference.com
 
C++
 
文件系统库
类
函数
文件类型
 
在标头 <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) 删除路径 p 所标识的文件或空目录，如同用 POSIX remove。不跟随符号链接（移除符号链接，而非其目标）。
2) 递归地删除 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) 抛出 std::filesystem::filesystem_error，构造时以 p 为第一路径实参并以OS 错误码为错误码实参。
2,4) 若 OS API 调用失败，则设置 std::error_code& 为 OS 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; // creates file containing 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 << " 个文件或目录\n";
}

可能的输出： 

remove(): true
remove(): false
remove_all(): 2 个文件或目录

[编辑] 缺陷报告

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

缺陷报告 应用于 出版时的行为 正确行为
LWG 3014 C++17 remove_all 的 error_code 重载被标记为 noexcept 但能分配内存 移除 noexcept

[编辑] 参阅

 删除文件
(函数) [编辑]
来自“https://zh.cppreference.com/mwiki/index.php?title=cpp/filesystem/remove&oldid=96348”