std::filesystem::relative, std::filesystem::proximate

 

C++

言語

標準ライブラリヘッダ

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

名前付き要件

言語サポートライブラリ

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

診断ライブラリ

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

文字列ライブラリ

コンテナライブラリ

イテレータライブラリ

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

アルゴリズムライブラリ

数値演算ライブラリ

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

入出力ライブラリ

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

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

アトミック操作ライブラリ (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

 

<tbody> </tbody>

ヘッダ <filesystem> で定義
path relative( const std::filesystem::path& p, std::error_code& ec);	(1)	(C++17以上)
path relative( const std::filesystem::path& p, const std::filesystem::path& base = std::filesystem::current_path()); path relative( const std::filesystem::path& p, const std::filesystem::path& base, std::error_code& ec);	(2)	(C++17以上)
path proximate( const std::filesystem::path& p, std::error_code& ec);	(3)	(C++17以上)
path proximate( const std::filesystem::path& p, const std::filesystem::path& base = std::filesystem::current_path()); path proximate( const std::filesystem::path& p, const std::filesystem::path& base, std::error_code& ec);	(4)	(C++17以上)

1) relative(p, current_path(), ec) を返します。

2) base に対して相対化された p を返します。 他の処理を行う前に、 p と base の両方について、シンボリックリンクを解決し、正規化します。 実質的にweakly_canonical(p).lexically_relative(weakly_canonical(base)) または weakly_canonical(p, ec).lexically_relative(weakly_canonical(base, ec)) を返します。 ただしエラーコード形式では最初にエラーが発生したときに path() を返します。

3) proximate(p, current_path(), ec) を返します。

4) 実質的に weakly_canonical(p).lexically_proximate(weakly_canonical(base)) または weakly_canonical(p, ec).lexically_proximate(weakly_canonical(base, ec)) を返します。 ただしエラーコード形式では最初にエラーが発生したときに path() を返します。

引数

p	-	存在するパス
base	-	p を相対化/近接化するための基準パス
ec	-	エラーを報告するための出力引数

戻り値

1) base に対して相対化された p

2) base に対して近接化された p

例外

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

関連項目

path (C++17)	パスを表します (クラス)
absolute (C++17)	絶対パスを組み立てます (関数)
canonicalweakly_canonical (C++17)	正規パスを組み立てます (関数)