NAME
renameat - rename a file relative to directory file descriptors
SYNOPSIS
#define _ATFILE_SOURCE
#include <stdio.h>
I int renameat(int olddirfd , const char * oldpath ,
I int newdirfd , const char * newpath );
DESCRIPTION
The
R renameat ()
system call operates in exactly the same way as
rename(2),
except for the differences described in this manual page.
If the pathname given in
oldpath
is relative, then it is interpreted relative to the directory
referred to by the file descriptor
R olddirfd
(rather than relative to the current working directory of
the calling process, as is done by
rename(2)
for a relative pathname).
If
oldpath
is relative and
olddirfd
is the special value
R AT_FDCWD ,
then
oldpath
is interpreted relative to the current working
directory of the calling process (like
rename(2)).
If
R oldpath
is absolute, then
olddirfd
is ignored.
The interpretation of
newpath
is as for
R oldpath ,
except that a relative pathname is interpreted relative
to the directory referred to by the file descriptor
R newdirfd .
RETURN VALUE
On success,
R renameat ()
returns 0.
On error, -1 is returned and
errno
is set to indicate the error.
ERRORS
The same errors that occur for
rename(2)
can also occur for
R renameat ().
The following additional errors can occur for
R renameat ():
EBADF
olddirfd
or
newdirfd
is not a valid file descriptor.
ENOTDIR
oldpath
is relative and
olddirfd
is a file descriptor referring to a file other than a directory;
or similar for
newpath
and
R newdirfd
VERSIONS
R renameat ()
was added to Linux in kernel 2.6.16.
CONFORMING TO
This system call is non-standard but is proposed
for inclusion in a future revision of POSIX.1.
NOTES
See
openat(2)
for an explanation of the need for
R renameat ().
SEE ALSO