9ad45a51425b667e1d3bcd5e19f985df9ac474fe
[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.5, FreeBSD 6.0, NetBSD 5.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 But the replacement function is not safe to be used in libraries and is not multithread-safe.
16 @end itemize
17
18 Portability problems not fixed by Gnulib:
19 @itemize
20 @item
21 This function always fails on platforms that don't support symlinks:
22 mingw
23 @item
24 When @code{readlink} is called on a directory: In the case of NFS mounted
25 directories, Cygwin sets @code{errno} to @code{ENOENT} or @code{EIO} instead of
26 @code{EINVAL}.  To avoid this problem, check for a directory before calling
27 @code{readlink}.
28 @item
29 When @code{readlink} is called on a file that is not a symbolic link:
30 Irix may set @code{errno} to @code{ENXIO} instead of @code{EINVAL}.  Cygwin
31 may set errno to @code{EACCES} instead of @code{EINVAL}.
32 @item
33 Symlink contents do not always have a trailing null byte, and there is
34 no indication if symlink contents were truncated if the return value
35 matches the length.  Furthermore, AIX 5.1 and HP-UX 11 set
36 @code{errno} to @code{ERANGE} rather than returning truncated
37 contents, and Linux sets @code{errno} to @code{EINVAL} if the
38 requested length is zero.  Use the gnulib module areadlink for
39 improved ability to read symlink contents.
40 @end itemize