original/man2/fstatat.2

   1 .\" Hey Emacs! This file is -*- nroff -*- source.
   2 .\"
   3 .\" This manpage is Copyright (C) 2006, Michael Kerrisk
   4 .\"
   5 .\" Permission is granted to make and distribute verbatim copies of this
   6 .\" manual provided the copyright notice and this permission notice are
   7 .\" preserved on all copies.
   8 .\"
   9 .\" Permission is granted to copy and distribute modified versions of this
  10 .\" manual under the conditions for verbatim copying, provided that the
  11 .\" entire resulting derived work is distributed under the terms of a
  12 .\" permission notice identical to this one.
  13 .\"
  14 .\" Since the Linux kernel and libraries are constantly changing, this
  15 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  16 .\" responsibility for errors or omissions, or for damages resulting from
  17 .\" the use of the information contained herein.  The author(s) may not
  18 .\" have taken the same level of care in the production of this manual,
  19 .\" which is licensed free of charge, as they might when working
  20 .\" professionally.
  21 .\"
  22 .\" Formatted or processed versions of this manual, if unaccompanied by
  23 .\" the source, must acknowledge the copyright and authors of this work.
  24 .\"
  25 .\"
  26 .TH FSTATAT 2 2009-12-13 "Linux" "Linux Programmer's Manual"
  27 .SH NAME
  28 fstatat \- get file status relative to a directory file descriptor
  29 .SH SYNOPSIS
  30 .nf
  31 .B #include <fcntl.h>           /* Definition of AT_* constants */
  32 .B #include <sys/stat.h>
  33 .sp
  34 .BI "int fstatat(int " dirfd ", const char *" pathname ", struct stat *" \
  35 buf ,
  36 .BI "            int " flags );
  37 .fi
  38 .sp
  39 .in -4n
  40 Feature Test Macro Requirements for glibc (see
  41 .BR feature_test_macros (7)):
  42 .in
  43 .sp
  44 .BR fstatat ():
  45 .PD 0
  46 .ad l
  47 .RS 4
  48 .TP 4
  49 Since glibc 2.10:
  50 _XOPEN_SOURCE\ >=\ 700 || _POSIX_C_SOURCE\ >=\ 200809L
  51 .TP
  52 Before glibc 2.10:
  53 _ATFILE_SOURCE
  54 .RE
  55 .ad
  56 .PD
  57 .SH DESCRIPTION
  58 The
  59 .BR fstatat ()
  60 system call operates in exactly the same way as
  61 .BR stat (2),
  62 except for the differences described in this manual page.
  63
  64 If the pathname given in
  65 .I pathname
  66 is relative, then it is interpreted relative to the directory
  67 referred to by the file descriptor
  68 .I dirfd
  69 (rather than relative to the current working directory of
  70 the calling process, as is done by
  71 .BR stat (2)
  72 for a relative pathname).
  73
  74 If
  75 .I pathname
  76 is relative and
  77 .I dirfd
  78 is the special value
  79 .BR AT_FDCWD ,
  80 then
  81 .I pathname
  82 is interpreted relative to the current working
  83 directory of the calling process (like
  84 .BR stat (2)).
  85
  86 If
  87 .I pathname
  88 is absolute, then
  89 .I dirfd
  90 is ignored.
  91
  92 .I flags
  93 can either be 0, or include the following flag:
  94 .TP
  95 .B AT_SYMLINK_NOFOLLOW
  96 If
  97 .I pathname
  98 is a symbolic link, do not dereference it:
  99 instead return information about the link itself, like
 100 .BR lstat (2).
 101 (By default,
 102 .BR fstatat ()
 103 dereferences symbolic links, like
 104 .BR stat (2).)
 105 .SH "RETURN VALUE"
 106 On success,
 107 .BR fstatat ()
 108 returns 0.
 109 On error, \-1 is returned and
 110 .I errno
 111 is set to indicate the error.
 112 .SH ERRORS
 113 The same errors that occur for
 114 .BR stat (2)
 115 can also occur for
 116 .BR fstatat ().
 117 The following additional errors can occur for
 118 .BR fstatat ():
 119 .TP
 120 .B EBADF
 121 .I dirfd
 122 is not a valid file descriptor.
 123 .TP
 124 .B EINVAL
 125 Invalid flag specified in
 126 .IR flags .
 127 .TP
 128 .B ENOTDIR
 129 .I pathname
 130 is relative and
 131 .I dirfd
 132 is a file descriptor referring to a file other than a directory.
 133 .SH VERSIONS
 134 .BR fstatat ()
 135 was added to Linux in kernel 2.6.16.
 136 .SH "CONFORMING TO"
 137 POSIX.1-2008.
 138 A similar system call exists on Solaris.
 139 .SH NOTES
 140 See
 141 .BR openat (2)
 142 for an explanation of the need for
 143 .BR fstatat ().
 144 .SH "SEE ALSO"
 145 .BR openat (2),
 146 .BR stat (2),
 147 .BR path_resolution (7),
 148 .BR symlink (7)