Name
fstatat — get file status relative to a directory file descriptor
Synopsis
#include <fcntl.h> /* Definition of AT_* constants */ #include <sys/stat.h>
int
fstatat( |
int dirfd, |
| const char *pathname, | |
| struct stat *buf, | |
int flags); |
![[Note]](../stylesheet/note.png) |
Note | |||||
|---|---|---|---|---|---|---|
|
DESCRIPTION
The fstatat() system call
operates in exactly the same way as stat(2), 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 stat(2) for a relative
pathname).
If 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 stat(2)).
If pathname is
absolute, then dirfd
is ignored.
flags can either
be 0, or include one or more of the following flags ORed:
AT_EMPTY_PATH(since Linux 2.6.39)-
If
pathnameis an empty string, operate on the file referred to bydirfd(which may have been obtained using the open(2)O_PATHflag). In this case,dirfdcan refer to any type of file, not just a directory. AT_NO_AUTOMOUNT(since Linux 2.6.38)-
Don't automount the terminal ("basename") component of
pathnameif it is a directory that is an automount point. This allows the caller to gather attributes of an automount point (rather than the location it would mount). This flag can be used in tools that scan directories to prevent mass-automounting of a directory of automount points. TheAT_NO_AUTOMOUNTflag has no effect if the mount point has already been mounted over. AT_SYMLINK_NOFOLLOW-
If
pathnameis a symbolic link, do not dereference it: instead return information about the link itself, like lstat(2). (By default,fstatat() dereferences symbolic links, like stat(2).)
RETURN VALUE
On success, fstatat()
returns 0. On error, −1 is returned and errno is set to indicate the error.
ERRORS
The same errors that occur for stat(2) can also occur for
fstatat(). The following
additional errors can occur for fstatat():
- EBADF
-
dirfdis not a valid file descriptor. - EINVAL
-
Invalid flag specified in
flags. - ENOTDIR
-
pathnameis relative anddirfdis a file descriptor referring to a file other than a directory.
VERSIONS
fstatat() was added to Linux
in kernel 2.6.16; library support was added to glibc in
version 2.4.
NOTES
See openat(2) for an
explanation of the need for fstatat().
The underlying system call employed by the glibc
fstatat() wrapper function is
actually called fstatat64().
COLOPHON
This page is part of release 3.54 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 %%%LICENSE_START(VERBATIM) 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. %%%LICENSE_END |