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

 

C++

编译器支持

独立和宿主式

语言

标准库

标准库头文件

具名要求

特性测试宏 (C++20)

语言支持库

概念库 (C++20)

诊断库

内存管理库

元编程库 (C++11)

通用工具库

容器库

迭代器库

范围库 (C++20)

算法库

字符串库

文本处理库

数值库

日期和时间库

输入/输出库

文件系统库 (C++17)

并发支持库 (C++11)

执行控制库 (C++26)

技术规范

符号索引

外部库

 

文件系统库

类
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::file_time_type filesystem::perms filesystem::perm_options filesystem::copy_options filesystem::directory_options
函数
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::temp_directory_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::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,2) 删除路径 p 所标识的文件或空目录，如同 POSIX remove 所为。不追踪符号链接（移除符号链接自身，而非其目标）。

3,4) 删除 p 的内容（如果它是目录），以及其所有子目录的内容，递归地，然后删除 p 自身，如同重复应用 POSIX remove 所为。不追踪符号链接（移除符号链接自身，而非其目标）。

参数

p	-	要删除的路径
ec	-	用于在非抛出重载中报告错误的 out-parameter。

返回值

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 系统上，此函数典型地按需调用 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'; // 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++ 标准。

DR	应用于	发布时的行为	正确的行为
LWG 3014	C++17	remove_all 的 error_code 重载标记为 noexcept 但可能分配内存	noexcept 已移除

参见

remove

擦除文件 (函数)