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

 

C++

编译器支持

自立实现与有宿主实现

语言

标准库

标准库标头

具名要求

功能特性测试宏 (C++20)

语言支持库

概念库 (C++20)

元编程库 (C++11)

诊断库

通用工具库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

本地化库

输入/输出库

文件系统库 (C++17)

正则表达式库 (C++11)

并发支持库 (C++11)

技术规范

符号索引

外部库

 

文件系统库

类
filesystem::path filesystem::filesystem_error filesystem::directory_entry filesystem::directory_iterator filesystem::recursive_directory_iterator filesystem::file_status	filesystem::space_info filesystem::file_type filesystem::perms filesystem::perm_options filesystem::copy_options filesystem::directory_options filesystem::file_time_type
函数
filesystem::absolute filesystem::canonicalfilesystem::weakly_canonical filesystem::relativefilesystem::proximate filesystem::copy filesystem::copy_file filesystem::copy_symlink filesystem::create_directory filesystem::create_directories filesystem::create_hard_link filesystem::create_symlink filesystem::create_directory_symlink filesystem::current_path	filesystem::exists filesystem::equivalent filesystem::file_size filesystem::hard_link_count filesystem::last_write_time filesystem::permissions filesystem::read_symlink filesystem::remove filesystem::remove_all filesystem::rename filesystem::resize_file filesystem::space filesystem::status filesystem::symlink_status filesystem::temp_directory_path
文件类型
filesystem::is_block_file filesystem::is_character_file filesystem::is_directory filesystem::is_empty filesystem::status_known	filesystem::is_fifo filesystem::is_other filesystem::is_regular_file filesystem::is_socket filesystem::is_symlink

 

在标头 <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 起)
std::uintmax_t remove_all( const std::filesystem::path& p, std::error_code& ec );	(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 错误码为错误码实参。

若 OS API 调用失败，则 @2,4@ 设置 std::error_code& 形参

为 OS API 错误码，而未发生错误时则执行 ec.clear()。

注解

在 POSIX 系统上，此函数通常按需调用 unlink 和 rmdir，在 Windows 上则是 DeleteFileW 和 RemoveDirectoryW。

示例

运行此代码

#include <cstdint>
#include <filesystem>
#include <iostream>
namespace fs = std::filesystem;
 
int main()
{
    fs::path tmp{std::filesystem::temp_directory_path()};
    std::filesystem::create_directories(tmp / "abcdef/example");
    std::uintmax_t n{fs::remove_all(tmp / "abcdef")};
    std::cout << "删除 " << n << " 个文件或目录\n";
}

可能的输出：

删除 2 个文件或目录

缺陷报告

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

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

参阅

remove

删除文件 (函数)