Actions

 Defined in header  std::filesystem::path read_symlink(const std::filesystem::path& p); std::filesystem::path read_symlink(const std::filesystem::path& p,                                    std::error_code& ec); (since C++17)

If the path p refers to a symbolic link, returns a new path object which refers to the target of that symbolic link.

It is an error if p does not refer to a symbolic link.

The non-throwing overload returns an empty path on errors.

Contents

Parameters

 p - path to a symlink ec - out-parameter for error reporting in the non-throwing overload

Return value

The target of the symlink (which may not necessarily exist)

Exceptions

The overload that does not take a parameter throws filesystem_error on underlying OS API errors, constructed with p as the first argument and the OS error code as the error code argument. std::bad_alloc may be thrown if memory allocation fails. The overload taking a parameter sets it to the OS API error code if an OS API call fails, and executes ec.clear() if no errors occur.

Example

#include <iostream>
#include <filesystem>
namespace fs = std::filesystem;
int main()
{
// on a typical Linux system, /lib/libc.so.6 is a symlink
fs::path p = "/lib/libc.so.6";
}
"/lib/libc.so.6" -> "libc-2.12.so"