SYMLINKATSection: Linux Programmer's Manual (2)
Index Return to Main Contents
NAMEsymlinkat - create a symbolic link relative to a directory file descriptor
#define _ATFILE_SOURCE #include <fcntl.h> /* Definition of AT_* constants */ #include <stdio.h> int symlinkat(const char *oldpath, int newdirfd, const char *newpath);
DESCRIPTIONThe symlinkat() system call operates in exactly the same way as symlink(2), except for the differences described in this manual page.
If the pathname given in newpath is relative, then it is interpreted relative to the directory referred to by the file descriptor newdirfd (rather than relative to the current working directory of the calling process, as is done by symlink(2) for a relative pathname).
If newpath is relative and newdirfd is the special value AT_FDCWD, then newpath is interpreted relative to the current working directory of the calling process (like symlink(2)).
RETURN VALUEOn success, symlinkat() returns 0. On error, -1 is returned and errno is set to indicate the error.
ERRORSThe same errors that occur for symlink(2) can also occur for symlinkat(). The following additional errors can occur for symlinkat():
- newdirfd is not a valid file descriptor.
- newpath is relative and newdirfd is a file descriptor referring to a file other than a directory.
VERSIONSsymlinkat() was added to Linux in kernel 2.6.16.
NOTESSee openat(2) for an explanation of the need for symlinkat().
SEE ALSOopenat(2), symlink(2), path_resolution(7), symlink(7)
COLOPHONThis page is part of release 3.21 of the Linux man-pages project. A description of the project, and information about reporting bugs, can be found at http://www.kernel.org/doc/man-pages/.