unlinkat — remove a directory entry relative to a directory file descriptor
#define _ATFILE_SOURCE #include <fcntl.h>
int
unlinkat( |
int | dirfd, |
| const char * | pathname, | |
| int | flags); |
The unlinkat() system call
operates in exactly the same way as either unlink(2) or rmdir(2) (depending on
whether or not flags
includes the AT_REMOVEDIR flag)
except for the differences described in this manual page.
If the pathname given in pathname is relative, then it
is interpreted relative to the directory referred to by the
file descriptor dirfd
(rather than relative to the current working directory of the
calling process, as is done by unlink(2) and rmdir(2) for a relative
pathname).
If the pathname given in pathname is relative and
dirfd is the special
value AT_FDCWD, then pathname is interpreted
relative to the current working directory of the calling
process (like unlink(2) and rmdir(2)).
If the pathname given in pathname is absolute, then
dirfd is ignored.
flags is a bit
mask that can either be specified as 0, or by ORing together
flag values that control the operation of unlinkat(). Currently only one such flags
is defined:
On success, unlinkat()
returns 0. On error, −1 is returned and errno is set to indicate the error.
The same errors that occur for unlink(2) and rmdir(2) can also occur for
unlinkat(). The following
additional errors can occur for unlinkat():
dirfd is not
a valid file descriptor.
An invalid flag value was specified in flags.
pathname is
relative and dirfd is a file
descriptor referring to a file other than a
directory.
This system call is non-standard but is proposed for inclusion in a future revision of POSIX.1. A similar system call exists on Solaris.
This page is part of release 2.79 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/.
|
This manpage is Copyright (C) 2006, Michael Kerrisk Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are preserved on all copies. Permission is granted to copy and distribute modified versions of this manual under the conditions for verbatim copying, provided that the entire resulting derived work is distributed under the terms of a permission notice identical to this one. Since the Linux kernel and libraries are constantly changing, this manual page may be incorrect or out-of-date. The author(s) assume no responsibility for errors or omissions, or for damages resulting from the use of the information contained herein. The author(s) may not have taken the same level of care in the production of this manual, which is licensed free of charge, as they might when working professionally. Formatted or processed versions of this manual, if unaccompanied by the source, must acknowledge the copyright and authors of this work. |