create_symlink.md

create_symlink

• filesystem[meta header]
• std::filesystem[meta namespace]
• function[meta id-type]
• cpp17[meta cpp]

namespace std::filesystem {
  void create_symlink(const path& to, const path& new_symlink); // (1)
  void create_symlink(const path& to, const path& new_symlink,
                      std::error_code& ec) noexcept;            // (2)
}

• path[link path.md]

概要

シンボリックリンクを作成する。

パスtoのファイルに対するシンボリックリンクをパスnew_symlinkに作成する。

効果

• POSIX環境では、symlink()関数を使用して、パスtoのファイル・ディレクトリに対するシンボリックリンクをパスnew_symlinkに作成する

戻り値

なし

例外

• (1) : ファイルシステムがエラーを報告する場合がある。エラーが発生した場合は、std::filesystem::filesystem_error例外を送出する
• (2) : 投げない

備考

• ファイルシステムによっては、この関数でディレクトリに対するシンボリックリンクを作成できない場合がある。より汎用的なプログラムを記述するのであれば、ディレクトリに対してはcreate_directory_symlink()関数を使用すること

例

#include <cassert>
#include <filesystem>
#include <fstream>

namespace fs = std::filesystem;

int main()
{
  std::ofstream{"regular.txt"};

  // regular.txtに対するシンボリックリンクをregular.symlinkファイルとして作成する
  fs::create_symlink("regular.txt", "regular.symlink");

  assert(fs::exists("regular.symlink"));
  assert(fs::is_symlink("regular.symlink"));
}

• fs::create_symlink[color ff0000]
• fs::exists[link exists.md]
• fs::is_symlink[link is_symlink.md]

出力

バージョン

言語

• C++17

処理系

• Clang: 7.0 [mark verified]
• GCC: 8.1 [mark verified]
• Visual C++: