65f088fa594686de3accc47821909af74150e372
[gnulib.git] / doc / posix-functions / readlinkat.texi
1 @node readlinkat
2 @section @code{readlinkat}
3 @findex readlinkat
4
5 POSIX specification: @url{http://www.opengroup.org/onlinepubs/9699919799/functions/readlinkat.html}
6
7 Gnulib module: readlinkat
8
9 Portability problems fixed by Gnulib:
10 @itemize
11 @item
12 This function is missing on some platforms:
13 glibc 2.3.6, MacOS X 10.3, FreeBSD 6.0, NetBSD 3.0, OpenBSD 3.8, AIX
14 5.1, HP-UX 11, IRIX 6.5, OSF/1 5.1, Solaris 10, Cygwin 1.5.x, mingw, Interix 3.5, BeOS.
15 @end itemize
16
17 Portability problems not fixed by Gnulib:
18 @itemize
19 @item
20 This function always fails on platforms that don't support symlinks:
21 mingw
22 @item
23 When @code{readlink} is called on a directory: In the case of NFS mounted
24 directories, Cygwin sets @code{errno} to @code{ENOENT} or @code{EIO} instead of
25 @code{EINVAL}.  To avoid this problem, check for a directory before calling
26 @code{readlink}.
27 @item
28 When @code{readlink} is called on a file that is not a symbolic link:
29 Irix may set @code{errno} to @code{ENXIO} instead of @code{EINVAL}.  Cygwin
30 may set errno to @code{EACCES} instead of @code{EINVAL}.
31 @item
32 Symlink contents do not always have a trailing null byte, and there is
33 no indication if symlink contents were truncated if the return value
34 matches the length.  Furthermore, AIX 5.1 and HP-UX 11 set
35 @code{errno} to @code{ERANGE} rather than returning truncated
36 contents, and Linux sets @code{errno} to @code{EINVAL} if the
37 requested length is zero.  Use the gnulib module areadlink for
38 improved ability to read symlink contents.
39 @end itemize