diff options
Diffstat (limited to 'src/lib/libc/stdlib/strtoul.3')
-rw-r--r-- | src/lib/libc/stdlib/strtoul.3 | 47 |
1 files changed, 31 insertions, 16 deletions
diff --git a/src/lib/libc/stdlib/strtoul.3 b/src/lib/libc/stdlib/strtoul.3 index 1353637d68..122ad7bb26 100644 --- a/src/lib/libc/stdlib/strtoul.3 +++ b/src/lib/libc/stdlib/strtoul.3 | |||
@@ -29,9 +29,9 @@ | |||
29 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | 29 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
30 | .\" SUCH DAMAGE. | 30 | .\" SUCH DAMAGE. |
31 | .\" | 31 | .\" |
32 | .\" $OpenBSD: strtoul.3,v 1.22 2013/08/14 06:32:28 jmc Exp $ | 32 | .\" $OpenBSD: strtoul.3,v 1.23 2014/09/14 14:32:44 schwarze Exp $ |
33 | .\" | 33 | .\" |
34 | .Dd $Mdocdate: August 14 2013 $ | 34 | .Dd $Mdocdate: September 14 2014 $ |
35 | .Dt STRTOUL 3 | 35 | .Dt STRTOUL 3 |
36 | .Os | 36 | .Os |
37 | .Sh NAME | 37 | .Sh NAME |
@@ -61,21 +61,21 @@ The | |||
61 | function converts the string in | 61 | function converts the string in |
62 | .Fa nptr | 62 | .Fa nptr |
63 | to an | 63 | to an |
64 | .Li unsigned long | 64 | .Vt unsigned long |
65 | value. | 65 | value. |
66 | The | 66 | The |
67 | .Fn strtoull | 67 | .Fn strtoull |
68 | function converts the string in | 68 | function converts the string in |
69 | .Fa nptr | 69 | .Fa nptr |
70 | to an | 70 | to an |
71 | .Li unsigned long long | 71 | .Vt unsigned long long |
72 | value. | 72 | value. |
73 | The | 73 | The |
74 | .Fn strtoumax | 74 | .Fn strtoumax |
75 | function converts the string in | 75 | function converts the string in |
76 | .Fa nptr | 76 | .Fa nptr |
77 | to a | 77 | to a |
78 | .Li umaxint_t | 78 | .Vt umaxint_t |
79 | value. | 79 | value. |
80 | The | 80 | The |
81 | .Fn strtouq | 81 | .Fn strtouq |
@@ -84,8 +84,7 @@ function is a deprecated equivalent of | |||
84 | and is provided for backwards compatibility with legacy programs. | 84 | and is provided for backwards compatibility with legacy programs. |
85 | The conversion is done according to the given | 85 | The conversion is done according to the given |
86 | .Fa base , | 86 | .Fa base , |
87 | which must be a number between 2 and 36 inclusive | 87 | which must be a number between 2 and 36 inclusive or the special value 0. |
88 | or the special value 0. | ||
89 | If the string in | 88 | If the string in |
90 | .Fa nptr | 89 | .Fa nptr |
91 | represents a negative number, it will be converted to its unsigned equivalent. | 90 | represents a negative number, it will be converted to its unsigned equivalent. |
@@ -111,9 +110,12 @@ is taken as 10 (decimal) unless the next character is | |||
111 | in which case it is taken as 8 (octal). | 110 | in which case it is taken as 8 (octal). |
112 | .Pp | 111 | .Pp |
113 | The remainder of the string is converted to an | 112 | The remainder of the string is converted to an |
114 | .Li unsigned long | 113 | .Vt unsigned long , |
115 | value in the obvious manner, stopping at the end of the string | 114 | .Vt unsigned long long , |
116 | or at the first character that does not produce a valid digit | 115 | or |
116 | .Vt uintmax_t | ||
117 | value in the obvious manner, | ||
118 | stopping at the first character which is not a valid digit | ||
117 | in the given base. | 119 | in the given base. |
118 | (In bases above 10, the letter | 120 | (In bases above 10, the letter |
119 | .Ql A | 121 | .Ql A |
@@ -172,12 +174,6 @@ and the global variable | |||
172 | .Va errno | 174 | .Va errno |
173 | is set to | 175 | is set to |
174 | .Er ERANGE . | 176 | .Er ERANGE . |
175 | If no conversion could be performed, 0 is returned; | ||
176 | the global variable | ||
177 | .Va errno | ||
178 | is also set to | ||
179 | .Er EINVAL , | ||
180 | though this is not portable across all platforms. | ||
181 | .Pp | 177 | .Pp |
182 | There is no way to determine if | 178 | There is no way to determine if |
183 | .Fn strtoul | 179 | .Fn strtoul |
@@ -185,6 +181,14 @@ has processed a negative number (and returned an unsigned value) short of | |||
185 | examining the string in | 181 | examining the string in |
186 | .Fa nptr | 182 | .Fa nptr |
187 | directly. | 183 | directly. |
184 | .Pp | ||
185 | If there is no valid digit, 0 is returned. | ||
186 | If | ||
187 | .Ar base | ||
188 | is invalid, 0 is returned and the global variable | ||
189 | .Va errno | ||
190 | is set to | ||
191 | .Er EINVAL . | ||
188 | .Sh EXAMPLES | 192 | .Sh EXAMPLES |
189 | Ensuring that a string is a valid number (i.e., in range and containing no | 193 | Ensuring that a string is a valid number (i.e., in range and containing no |
190 | trailing characters) requires clearing | 194 | trailing characters) requires clearing |
@@ -222,6 +226,10 @@ alternately, use | |||
222 | .Xr sscanf 3 . | 226 | .Xr sscanf 3 . |
223 | .Sh ERRORS | 227 | .Sh ERRORS |
224 | .Bl -tag -width Er | 228 | .Bl -tag -width Er |
229 | .It Bq Er EINVAL | ||
230 | The value of | ||
231 | .Ar base | ||
232 | was neither between 2 and 36 inclusive nor the special value 0. | ||
225 | .It Bq Er ERANGE | 233 | .It Bq Er ERANGE |
226 | The given string was out of range; the value converted has been clamped. | 234 | The given string was out of range; the value converted has been clamped. |
227 | .El | 235 | .El |
@@ -236,6 +244,13 @@ and | |||
236 | .Fn strtoumax | 244 | .Fn strtoumax |
237 | functions conform to | 245 | functions conform to |
238 | .St -ansiC-99 . | 246 | .St -ansiC-99 . |
247 | Setting | ||
248 | .Va errno | ||
249 | to | ||
250 | .Dv EINVAL | ||
251 | is an extension to that standard required by | ||
252 | .St -p1003.1-2008 . | ||
253 | .Pp | ||
239 | The | 254 | The |
240 | .Fn strtouq | 255 | .Fn strtouq |
241 | function is a | 256 | function is a |