C++ 参考手册

位置:首页 > C++ 参考手册 >文件系统库 > std::filesystem::remove, std::filesystem::remove_all

定义于头文件 <filesystem>
bool remove(const std::filesystem::path& p);
bool remove(const std::filesystem::path& p, std::error_code& ec) noexcept;
(1) (C++17 起)
(2) (C++17 起)
1) 删除路径 p 所标识的文件或空目录,如同用 POSIX remove 。不跟随符号链接(移除符号链接,而非其目标)
2) 递归地删除 p 的内容(若它是目录)及其所有子目录的内容,然后删除 p 自身,如同重复应用 POSIX remove 。不跟随符号链接(移除符号链接,而非其目标)

参数

p - 要删除的路径
ec - 不抛出重载中报告错误的输出参数

返回值

1) 若文件被删除则为 true ,若文件不存在则为 false 。接受 error_code& 参数的重载在错误时返回 false
2) 返回被删除的文件及目录数量(可以是零,若用以起始的 p 不存在)。接受 error_code& 参数的重载在错误时返回 static_cast<std::uintmax_t>(-1)

异常

不接受 std::error_code& 参数的重载在底层 OS API 错误时抛出 filesystem_error ,以第一 path 参数 p 和作为错误码参数的 OS 错误码构造。若 OS API 调用失败,则接受 std::error_code& 参数的重载设置该参数为 OS API 错误码,而若不出现错误则执行 ec.clear() 。若内存分配失败,则任何不标记为 noexcept 的重载可能抛出 std::bad_alloc

注意

在 POSIX 系统上,此函数通常按需调用 unlinkrmdir ,在 Windows 上则是 RemoveDirectoryWDeleteFileW

缺陷报告

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

DR 应用于 出版时的行为 正确行为
LWG 3014 C++17 remove_allerror_code 重载被标记为 noexcept 但能分配内存 移除 noexcept

示例

#include <iostream>
#include <cstdint>
#include <filesystem>
namespace fs = std::filesystem;
int main()
{
    fs::path dir = fs::temp_directory_path();
    fs::create_directories(dir / "abcdef/example");
    std::uintmax_t n = fs::remove_all(dir / "abcdef");
    std::cout << "Deleted " << n << " files or directories\n";
}

可能的输出:

Deleted 2 files or directories

参阅

删除文件
(函数)