summaryrefslogtreecommitdiff
path: root/src/lib/libc/string/strerror.3
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/libc/string/strerror.3')
-rw-r--r--src/lib/libc/string/strerror.385
1 files changed, 85 insertions, 0 deletions
diff --git a/src/lib/libc/string/strerror.3 b/src/lib/libc/string/strerror.3
new file mode 100644
index 0000000000..fa573bc72a
--- /dev/null
+++ b/src/lib/libc/string/strerror.3
@@ -0,0 +1,85 @@
1.\" Copyright (c) 1980, 1991 Regents of the University of California.
2.\" All rights reserved.
3.\"
4.\" This code is derived from software contributed to Berkeley by
5.\" the American National Standards Committee X3, on Information
6.\" Processing Systems.
7.\"
8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions
10.\" are met:
11.\" 1. Redistributions of source code must retain the above copyright
12.\" notice, this list of conditions and the following disclaimer.
13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\" notice, this list of conditions and the following disclaimer in the
15.\" documentation and/or other materials provided with the distribution.
16.\" 3. Neither the name of the University nor the names of its contributors
17.\" may be used to endorse or promote products derived from this software
18.\" without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.\" $OpenBSD: strerror.3,v 1.6 2003/06/02 20:18:38 millert Exp $
33.\"
34.Dd June 29, 1991
35.Dt STRERROR 3
36.Os
37.Sh NAME
38.Nm strerror
39.Nd get error message string
40.Sh SYNOPSIS
41.Fd #include <string.h>
42.Ft char *
43.Fn strerror "int errnum"
44.Ft int
45.Fn strerror_r "int errnum" "char *strerrbuf" "size_t buflen"
46.Sh DESCRIPTION
47The
48.Fn strerror
49function returns a pointer to the language-dependent error message
50string affiliated with the specified error number
51.Fa errnum .
52The returned string contains a maximum of
53.Dv NL_TEXTMAX
54characters, including the trailing NUL.
55.Pp
56The array pointed to is not to be modified by the program, but may be
57overwritten by subsequent calls to
58.Fn strerror .
59.Pp
60.Fn strerror_r
61is a thread safe version of
62.Fn strerror
63that places the error message in the given buffer
64.Fa strerrbuf .
65If the error message is larger then
66.Fa buflen
67the message will be truncated to fit within buflen and
68.Er ERANGE
69is returned.
70.Fn strerror_r
71returns zero upon successful completion.
72An error number is returned, otherwise.
73.Sh SEE ALSO
74.Xr intro 2 ,
75.Xr perror 3 ,
76.Xr setlocale 3
77.Sh STANDARDS
78The
79.Fn strerror
80function conforms to
81.St -ansiC .
82The
83.Fn strerror_r
84function conforms to
85.St -p1003.1 .