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

 

C++

編譯器支援

自由（freestanding）與宿主（hosted）

語言

標準庫

標準庫標頭檔案

具名要求

特性測試宏 (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	-	用於在不丟擲異常的過載中報告錯誤的輸出引數。

返回值

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++ 標準。

缺陷報告	應用於	釋出時的行為	正確的行為
LWG 3014	C++17	remove_all 的 error_code 過載被標記為 noexcept 但可以分配記憶體	noexcept 已移除

參閱

remove

擦除檔案 (函式)