Merge commit 'snapshot-start' into stable
[gnulib.git] / doc / posix-functions / strerror_r.texi
1 @node strerror_r
2 @section @code{strerror_r}
3 @findex strerror_r
4
5 POSIX specification:@* @url{http://www.opengroup.org/onlinepubs/9699919799/functions/strerror_r.html}
6
7 Gnulib module: strerror_r-posix
8
9 Portability problems fixed by Gnulib:
10 @itemize
11 @item
12 This function is missing on some platforms:
13 NetBSD 3.0, HP-UX 11.23, IRIX 6.5, Solaris 9, mingw.
14 @item
15 glibc and Cygwin have an incompatible version of this function.  The
16 POSIX compliant code
17 @smallexample
18 char *s = (strerror_r (err, buf, buflen) == 0 ? buf : NULL);
19 @end smallexample
20 is essentially equivalent to this code using the glibc function:
21 @smallexample
22 char *s = strerror_r (err, buf, buflen);
23 @end smallexample
24 @item
25 This function is sometimes not declared in @code{<string.h>} on some platforms:
26 glibc 2.8, OSF/1 5.1.
27 @item
28 The third argument is of type @code{int} instead of @code{size_t} on some
29 platforms:
30 AIX 5.1, OSF/1 5.1.
31 @item
32 When this function fails, it returns -1 and sets @code{errno}, instead of
33 returning the error number, on some platforms:
34 glibc 2.12 with @code{-D_POSIX_C_SOURCE=200112L}, AIX 6.1, OSF/1 5.1.
35 @item
36 This function does not support the error values that are specified by POSIX
37 but not defined by the system, on some platforms:
38 OpenBSD 4.0, OSF/1 5.1, NonStop Kernel, Cygwin 1.5.x.
39 @item
40 This function always fails when the third argument is less than 80 on some
41 platforms:
42 HP-UX 11.31.
43 @item
44 When the buffer is too small, this function does not fail, but instead
45 truncates the result and returns 0 on some platforms:
46 OSF/1 5.1.
47 @end itemize
48
49 Portability problems not fixed by Gnulib:
50 @itemize
51 @item
52 When the buffer is too small, this function does not fail, but instead
53 truncates the result and returns 0 on some platforms:
54 AIX 6.1.
55 @end itemize