std::filesystem::copy_symlink

From cppreference.com

Compiler support
Freestanding and hosted
Language
Standard library
Standard library headers
Named requirements
Feature test macros(C++20)
Language support library
Concepts library(C++20)
Diagnostics library
Memory management library
Metaprogramming library(C++11)
General utilities library
Containers library
Iterators library
Ranges library(C++20)
Algorithms library
Strings library
Text processing library
Numerics library
Date and time library
Input/output library
Filesystem library(C++17)
Concurrency support library(C++11)
Execution control library(C++26)
Technical specifications
Symbols index
External libraries

[edit]

Filesystem library

Classes

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

Functions

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

File types

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

[edit]

Defined in header`<filesystem>`
void copy_symlink(conststd::filesystem::path& from, conststd::filesystem::path& to);	(1)	(since C++17)
void copy_symlink(conststd::filesystem::path& from, conststd::filesystem::path& to, std::error_code& ec)noexcept;	(2)	(since C++17)

Copies a symlink to another location.

1) Effectively callsf(read_symlink(from), to) wheref iscreate_symlink orcreate_directory_symlink depending on whetherfrom resolves to a file or directory.

2) Effectively callsf(read_symlink(from, ec), to, ec) wheref iscreate_symlink orcreate_directory_symlink depending on whetherfrom resolves to a file or directory.

[edit]Parameters

from	-	path to a symbolic link to copy
to	-	destination path of the new symlink
ec	-	out-parameter for error reporting in the non-throwing overload

[edit]Return value

(none)

[edit]Exceptions

Any overload not markednoexcept may throwstd::bad_alloc if memory allocation fails.

1) Throwsstd::filesystem::filesystem_error on underlying OS API errors, constructed withfrom as the first path argument,to as the second path argument, and the OS error code as the error code argument.

2) Sets astd::error_code& parameter to the OS API error code if an OS API call fails, and executesec.clear() if no errors occur.

[edit]Example

This section is incomplete
Reason: no example

[edit]See also

copy (C++17)	copies files or directories (function)[edit]
copy_file (C++17)	copies file contents (function)[edit]
create_symlinkcreate_directory_symlink (C++17)(C++17)	creates a symbolic link (function)[edit]
read_symlink (C++17)	obtains the target of a symbolic link (function)[edit]