summaryrefslogtreecommitdiff
path: root/src/lib/libc/stdlib/strtol.3
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/libc/stdlib/strtol.3')
-rw-r--r--src/lib/libc/stdlib/strtol.3168
1 files changed, 168 insertions, 0 deletions
diff --git a/src/lib/libc/stdlib/strtol.3 b/src/lib/libc/stdlib/strtol.3
new file mode 100644
index 0000000000..b7d2cd1225
--- /dev/null
+++ b/src/lib/libc/stdlib/strtol.3
@@ -0,0 +1,168 @@
1.\" Copyright (c) 1990, 1991 The Regents of the University of California.
2.\" All rights reserved.
3.\"
4.\" This code is derived from software contributed to Berkeley by
5.\" Chris Torek and the American National Standards Committee X3,
6.\" on Information 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. All advertising materials mentioning features or use of this software
17.\" must display the following acknowledgement:
18.\" This product includes software developed by the University of
19.\" California, Berkeley and its contributors.
20.\" 4. Neither the name of the University nor the names of its contributors
21.\" may be used to endorse or promote products derived from this software
22.\" without specific prior written permission.
23.\"
24.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34.\" SUCH DAMAGE.
35.\"
36.\" $OpenBSD: strtol.3,v 1.3 1996/08/19 08:33:51 tholo Exp $
37.\"
38.Dd June 25, 1992
39.Dt STRTOL 3
40.Os
41.Sh NAME
42.Nm strtol, strtoq
43.Nd convert string value to a long or quad_t integer
44.Sh SYNOPSIS
45.Fd #include <stdlib.h>
46.Fd #include <limits.h>
47.Ft long
48.Fn strtol "const char *nptr" "char **endptr" "int base"
49
50.Fd #include <sys/types.h>
51.Fd #include <stdlib.h>
52.Fd #include <limits.h>
53.Ft quad_t
54.Fn strtoq "const char *nptr" "char **endptr" "int base"
55.Sh DESCRIPTION
56The
57.Fn strtol
58function
59converts the string in
60.Fa nptr
61to a
62.Em long
63value.
64The
65.Fn strtoq
66function
67converts the string in
68.Fa nptr
69to a
70.Em quad_t
71value.
72The conversion is done according to the given
73.Fa base ,
74which must be between 2 and 36 inclusive,
75or be the special value 0.
76.Pp
77The string may begin with an arbitrary amount of white space
78(as determined by
79.Xr isspace 3 )
80followed by a single optional
81.Ql +
82or
83.Ql -
84sign.
85If
86.Fa base
87is zero or 16,
88the string may then include a
89.Ql 0x
90prefix,
91and the number will be read in base 16; otherwise, a zero
92.Fa base
93is taken as 10 (decimal) unless the next character is
94.Ql 0 ,
95in which case it is taken as 8 (octal).
96.Pp
97The remainder of the string is converted to a
98.Em long
99value in the obvious manner,
100stopping at the first character which is not a valid digit
101in the given base.
102(In bases above 10, the letter
103.Ql A
104in either upper or lower case
105represents 10,
106.Ql B
107represents 11, and so forth, with
108.Ql Z
109representing 35.)
110.Pp
111If
112.Fa endptr
113is non nil,
114.Fn strtol
115stores the address of the first invalid character in
116.Fa *endptr .
117If there were no digits at all, however,
118.Fn strtol
119stores the original value of
120.Fa nptr
121in
122.Fa *endptr .
123(Thus, if
124.Fa *nptr
125is not
126.Ql \e0
127but
128.Fa **endptr
129is
130.Ql \e0
131on return, the entire string was valid.)
132.Sh RETURN VALUES
133The
134.Fn strtol
135function
136returns the result of the conversion,
137unless the value would underflow or overflow.
138If an underflow occurs,
139.Fn strtol
140returns
141.Dv LONG_MIN .
142If an overflow occurs,
143.Fn strtol
144returns
145.Dv LONG_MAX .
146In both cases,
147.Va errno
148is set to
149.Er ERANGE .
150.Sh ERRORS
151.Bl -tag -width Er
152.It Bq Er ERANGE
153The given string was out of range; the value converted has been clamped.
154.El
155.Sh SEE ALSO
156.Xr atof 3 ,
157.Xr atoi 3 ,
158.Xr atol 3 ,
159.Xr strtod 3 ,
160.Xr strtoul 3
161.Sh STANDARDS
162The
163.Fn strtol
164function
165conforms to
166.St -ansiC .
167.Sh BUGS
168Ignores the current locale.