std::experimental::filesystem::create_symlink,std::experimental::filesystem::create_directory_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]

Experimental

Technical Specification
Filesystem library(filesystem TS)
Library fundamentals(library fundamentals TS)
Library fundamentals 2(library fundamentals TS v2)
Library fundamentals 3(library fundamentals TS v3)
Extensions for parallelism(parallelism TS)
Extensions for parallelism 2(parallelism TS v2)
Extensions for concurrency(concurrency TS)
Extensions for concurrency 2(concurrency TS v2)
Concepts(concepts TS)
Ranges(ranges TS)
Reflection(reflection TS)
Mathematical special functions(special functions TR)
Experimental Non-TS
Pattern Matching
Linear Algebra
std::execution
Contracts
2D Graphics

[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::perms
filesystem::copy_options
filesystem::directory_options
filesystem::file_time_type

Functions

filesystem::absolute filesystem::system_complete
filesystem::canonical
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

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`<experimental/filesystem>`
void create_symlink(const path& target,const path& link); void create_symlink(const path& target,const path& link, error_code& ec);	(1)	(filesystem TS)
void create_directory_symlink(const path& target,const path& link); void create_directory_symlink(const path& target,const path& link, error_code& ec);	(2)	(filesystem TS)

Creates a symbolic linklink with its target set totarget as if by POSIXsymlink(): the pathnametarget may be invalid or non-existing.

Some operating systems require symlink creation to identify that the link is to a directory. Portable code should use(2) to create directory symlinks rather than(1), even though there is no distinction on POSIX systems.

[edit]Parameters

target	-	path to point the symlink to, does not have to exist
link	-	path of the new symbolic link
ec	-	out-parameter for error reporting in the non-throwing overload

[edit]Return value

(none)

[edit]Exceptions

The overload that does not take anerror_code& parameter throwsfilesystem_error on underlying OS API errors, constructed withtarget as the first argument,link as the second argument, and the OS error code as the error code argument.std::bad_alloc may be thrown if memory allocation fails. The overload taking anerror_code& parameter sets it to the OS API error code if an OS API call fails, and executesec.clear() if no errors occur. This overload has

noexcept specification:

noexcept

[edit]Notes

Some operating systems do not support symbolic links at all or support them only for regular files.

Some file systems do not support symbolic links regardless of the operating system, for example the FAT system used on some memory cards and flash drives.

Like a hard link, a symbolic link allows a file to have multiple logical names. The presence of a hard link guarantees the existence of a file, even after the original name has been removed. A symbolic link provides no such assurance; in fact, the file named by thetarget argument need not exist when the link is created. A symbolic link can cross file system boundaries.

[edit]Example

Run this code

#include <experimental/filesystem>#include <iostream>namespace fs= std::experimental::filesystem; int main(){    fs::create_directories("sandbox/subdir");    fs::create_symlink("target","sandbox/sym1");    fs::create_directory_symlink("subdir","sandbox/sym2"); for(auto it= fs::directory_iterator("sandbox"); it!= fs::directory_iterator();++it)if(is_symlink(it->symlink_status()))std::cout<<*it<<"->"<< read_symlink(*it)<<'\n';     fs::remove_all("sandbox");}

Possible output:

"sandbox/sym1"->"target""sandbox/sym2"->"subdir"

[edit]See also

statussymlink_status	determines file attributes determines file attributes, checking the symlink target (function)[edit]
read_symlink	obtains the target of a symbolic link (function)[edit]
create_hard_link	creates a hard link (function)[edit]