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

 

C++

言語

標準ライブラリヘッダ

フリースタンディング処理系とホスト処理系

名前付き要件

言語サポートライブラリ

コンセプトライブラリ (C++20)

診断ライブラリ

ユーティリティライブラリ

文字列ライブラリ

コンテナライブラリ

イテレータライブラリ

範囲ライブラリ (C++20)

アルゴリズムライブラリ

数値演算ライブラリ

入出力ライブラリ

ローカライゼーションライブラリ

正規表現ライブラリ (C++11)

アトミック操作ライブラリ (C++11)

スレッドサポートライブラリ (C++11)

ファイルシステムライブラリ (C++17)

技術仕様書

 

ファイルシステムライブラリ

クラス
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); bool remove(const std::filesystem::path& p, std::error_code& ec) noexcept;	(1)	(C++17以上)
std::uintmax_t remove_all(const std::filesystem::path& p); std::uintmax_t remove_all(const std::filesystem::path& p, std::error_code& ec);	(2)	(C++17以上)

1) POSIX の remove によって行われたかのように、パス p の指すファイルまたは空ディレクトリが削除されます。 シンボリックリンクは辿られません (ターゲットではなくシンボリックリンクが削除されます)。

2) POSIX の remove を繰り返し適用したかのように、 p の内容とそのすべてのサブディレクトリの内容を再帰的に削除し (ディレクトリの場合)、その後 p 自身を削除します。 シンボリックリンクは辿られません (ターゲットではなくシンボリックリンクが削除されます)。

引数

p	-	削除するパス
ec	-	例外を投げないオーバーロードでエラーを報告するための出力引数

戻り値

1) ファイルが削除された場合は true、存在しなかった場合は false。 error_code& 引数を取るオーバーロードは、エラーが発生した場合、 false を返します。

2) 削除されたファイルとディレクトリの数 (p が元から存在しなければ、ゼロになるかもしれません)。 error_code& 引数を取るオーバーロードは、エラーが発生した場合、 static_cast<std::uintmax_t>(-1) を返します。

例外

std::error_code& 引数を取らないオーバーロードは、ベースとなる OS の API でエラーが発生した場合、第1パス引数に p、エラーコード引数に OS のエラーコードを指定して構築された filesystem_error を投げます。 std::error_code& 引数を取るオーバーロードは、 OS の API 呼び出しが失敗した場合、その引数を OS の API のエラーコードに設定し、エラーが発生しない場合は ec.clear() を実行します。 noexcept 指定のないあらゆるオーバーロードは、メモリ確保に失敗した場合 std::bad_alloc を投げる可能性があります。

ノート

POSIX システムでは、この関数は一般的に、必要に応じて unlink と rmdir を呼びます。 Windows では、 RemoveDirectoryW と DeleteFileW を呼びます。

欠陥報告

以下の動作変更欠陥報告は以前に発行された C++ 標準に遡って適用されました。

DR	適用先	発行時の動作	正しい動作
LWG 3014	C++17	error_code overload of remove_all marked noexcept but can allocate memory	noexcept removed

例

Run this code

#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

関連項目

remove

ファイルを消去します (関数)