diff options
author | deraadt <> | 1995-10-18 08:42:23 +0000 |
---|---|---|
committer | deraadt <> | 1995-10-18 08:42:23 +0000 |
commit | 0527d29da443886d92e9a418180c5b25a5f8d270 (patch) | |
tree | 86b3a64928451a669cefa27900e5884036b4e349 /src/lib/libc/stdlib/strtoul.3 | |
download | openbsd-0527d29da443886d92e9a418180c5b25a5f8d270.tar.gz openbsd-0527d29da443886d92e9a418180c5b25a5f8d270.tar.bz2 openbsd-0527d29da443886d92e9a418180c5b25a5f8d270.zip |
initial import of NetBSD tree
Diffstat (limited to 'src/lib/libc/stdlib/strtoul.3')
-rw-r--r-- | src/lib/libc/stdlib/strtoul.3 | 164 |
1 files changed, 164 insertions, 0 deletions
diff --git a/src/lib/libc/stdlib/strtoul.3 b/src/lib/libc/stdlib/strtoul.3 new file mode 100644 index 0000000000..db551b0141 --- /dev/null +++ b/src/lib/libc/stdlib/strtoul.3 | |||
@@ -0,0 +1,164 @@ | |||
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 | .\" from: @(#)strtoul.3 5.4 (Berkeley) 6/25/92 | ||
37 | .\" $Id: strtoul.3,v 1.1.1.1 1995/10/18 08:42:20 deraadt Exp $ | ||
38 | .\" | ||
39 | .Dd June 25, 1992 | ||
40 | .Dt STRTOUL 3 | ||
41 | .Os | ||
42 | .Sh NAME | ||
43 | .Nm strtoul, strtouq | ||
44 | .Nd convert a string to an unsigned long or uquad_t integer | ||
45 | .Sh SYNOPSIS | ||
46 | .Fd #include <stdlib.h> | ||
47 | .Fd #include <limits.h> | ||
48 | .Ft unsigned long | ||
49 | .Fn strtoul "const char *nptr" "char **endptr" "int base" | ||
50 | |||
51 | .Fd #include <sys/types.h> | ||
52 | .Fd #include <stdlib.h> | ||
53 | .Fd #include <limits.h> | ||
54 | .Ft u_quad_t | ||
55 | .Fn strtouq "const char *nptr" "char **endptr" "int base" | ||
56 | .Sh DESCRIPTION | ||
57 | The | ||
58 | .Fn strtoul | ||
59 | function | ||
60 | converts the string in | ||
61 | .Fa nptr | ||
62 | to an | ||
63 | .Em unsigned long | ||
64 | value. | ||
65 | The | ||
66 | .Fn strtouq | ||
67 | function | ||
68 | converts the string in | ||
69 | .Fa nptr | ||
70 | to a | ||
71 | .Em u_quad_t | ||
72 | value. | ||
73 | The conversion is done according to the given | ||
74 | .Fa base , | ||
75 | which must be between 2 and 36 inclusive, | ||
76 | or be the special value 0. | ||
77 | .Pp | ||
78 | The string may begin with an arbitrary amount of white space | ||
79 | (as determined by | ||
80 | .Xr isspace 3 ) | ||
81 | followed by a single optional | ||
82 | .Ql + | ||
83 | or | ||
84 | .Ql - | ||
85 | sign. | ||
86 | If | ||
87 | .Fa base | ||
88 | is zero or 16, | ||
89 | the string may then include a | ||
90 | .Ql 0x | ||
91 | prefix, | ||
92 | and the number will be read in base 16; otherwise, a zero | ||
93 | .Fa base | ||
94 | is taken as 10 (decimal) unless the next character is | ||
95 | .Ql 0 , | ||
96 | in which case it is taken as 8 (octal). | ||
97 | .Pp | ||
98 | The remainder of the string is converted to an | ||
99 | .Em unsigned long | ||
100 | value in the obvious manner, | ||
101 | stopping at the end of the string | ||
102 | or at the first character that does not produce a valid digit | ||
103 | in the given base. | ||
104 | (In bases above 10, the letter | ||
105 | .Ql A | ||
106 | in either upper or lower case | ||
107 | represents 10, | ||
108 | .Ql B | ||
109 | represents 11, and so forth, with | ||
110 | .Ql Z | ||
111 | representing 35.) | ||
112 | .Pp | ||
113 | If | ||
114 | .Fa endptr | ||
115 | is non nil, | ||
116 | .Fn strtoul | ||
117 | stores the address of the first invalid character in | ||
118 | .Fa *endptr . | ||
119 | If there were no digits at all, however, | ||
120 | .Fn strtoul | ||
121 | stores the original value of | ||
122 | .Fa nptr | ||
123 | in | ||
124 | .Fa *endptr . | ||
125 | (Thus, if | ||
126 | .Fa *nptr | ||
127 | is not | ||
128 | .Ql \e0 | ||
129 | but | ||
130 | .Fa **endptr | ||
131 | is | ||
132 | .Ql \e0 | ||
133 | on return, the entire string was valid.) | ||
134 | .Sh RETURN VALUES | ||
135 | The | ||
136 | .Fn strtoul | ||
137 | function | ||
138 | returns either the result of the conversion | ||
139 | or, if there was a leading minus sign, | ||
140 | the negation of the result of the conversion, | ||
141 | unless the original (non-negated) value would overflow; | ||
142 | in the latter case, | ||
143 | .Fn strtoul | ||
144 | returns | ||
145 | .Dv ULONG_MAX | ||
146 | and sets the global variable | ||
147 | .Va errno | ||
148 | to | ||
149 | .Er ERANGE . | ||
150 | .Sh ERRORS | ||
151 | .Bl -tag -width Er | ||
152 | .It Bq Er ERANGE | ||
153 | The given string was out of range; the value converted has been clamped. | ||
154 | .El | ||
155 | .Sh SEE ALSO | ||
156 | .Xr strtol 3 | ||
157 | .Sh STANDARDS | ||
158 | The | ||
159 | .Fn strtoul | ||
160 | function | ||
161 | conforms to | ||
162 | .St -ansiC . | ||
163 | .Sh BUGS | ||
164 | Ignores the current locale. | ||