1.\" Copyright (c) 1990, 1991, 1993 2.\" The Regents of the University of California. 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.\" @(#)strtoul.3 8.1 (Berkeley) 6/4/93 37.\" $FreeBSD$ 38.\" 39.Dd June 4, 1993 40.Dt STRTOUL 3 41.Os 42.Sh NAME 43.Nm strtoul , strtoull , strtouq 44.Nd "convert a string to an unsigned long, unsigned long long, or uquad_t integer" 45.Sh LIBRARY 46.Lb libc 47.Sh SYNOPSIS 48.Fd #include <stdlib.h> 49.Fd #include <limits.h> 50.Ft unsigned long 51.Fn strtoul "const char *nptr" "char **endptr" "int base" 52.Ft unsigned long long 53.Fn strtoull "const char *nptr" "char **endptr" "int base" 54.Fd #include <sys/types.h> 55.Fd #include <stdlib.h> 56.Fd #include <limits.h> 57.Ft u_quad_t 58.Fn strtouq "const char *nptr" "char **endptr" "int base" 59.Sh DESCRIPTION 60The 61.Fn strtoul 62function 63converts the string in 64.Fa nptr 65to an 66.Em unsigned long 67value. 68The 69.Fn strtoull 70function 71converts the string in 72.Fa nptr 73to an 74.Em unsigned long long 75value. 76The 77.Fn strtouq 78function 79converts the string in 80.Fa nptr 81to a 82.Em u_quad_t 83value. 84The conversion is done according to the given 85.Fa base , 86which must be between 2 and 36 inclusive, 87or be the special value 0. 88.Pp 89The string may begin with an arbitrary amount of white space 90(as determined by 91.Xr isspace 3 ) 92followed by a single optional 93.Ql + 94or 95.Ql - 96sign. 97If 98.Fa base 99is zero or 16, 100the string may then include a 101.Ql 0x 102prefix, 103and the number will be read in base 16; otherwise, a zero 104.Fa base 105is taken as 10 (decimal) unless the next character is 106.Ql 0 , 107in which case it is taken as 8 (octal). 108.Pp 109The remainder of the string is converted to an 110.Em unsigned long 111value in the obvious manner, 112stopping at the end of the string 113or at the first character that does not produce a valid digit 114in the given base. 115(In bases above 10, the letter 116.Ql A 117in either upper or lower case 118represents 10, 119.Ql B 120represents 11, and so forth, with 121.Ql Z 122representing 35.) 123.Pp 124If 125.Fa endptr 126is non nil, 127.Fn strtoul 128stores the address of the first invalid character in 129.Fa *endptr . 130If there were no digits at all, however, 131.Fn strtoul 132stores the original value of 133.Fa nptr 134in 135.Fa *endptr . 136(Thus, if 137.Fa *nptr 138is not 139.Ql \e0 140but 141.Fa **endptr 142is 143.Ql \e0 144on return, the entire string was valid.) 145.Sh RETURN VALUES 146The 147.Fn strtoul 148function 149returns either the result of the conversion 150or, if there was a leading minus sign, 151the negation of the result of the conversion, 152unless the original (non-negated) value would overflow; 153in the latter case, 154.Fn strtoul 155returns 156.Dv ULONG_MAX . 157The 158.Fn strtoull 159function 160returns either the result of the conversion 161or, if there was a leading minus sign, 162the negation of the result of the conversion, 163unless the original (non-negated) value would overflow; 164in the latter case, 165.Fn strtoull 166returns 167.Dv ULLONG_MAX . 168In all cases, 169.Va errno 170is set to 171.Er ERANGE . 172.Sh ERRORS 173.Bl -tag -width Er 174.It Bq Er ERANGE 175The given string was out of range; the value converted has been clamped. 176.El 177.Sh SEE ALSO 178.Xr strtol 3 179.Sh STANDARDS 180The 181.Fn strtoul 182function 183conforms to 184.St -isoC . 185The 186.Fn strtoull 187function 188conforms to 189.St -isoC-99 . 190The 191.Bx 192.Fn strtoq 193function is deprecated. 194.Sh BUGS 195Ignores the current locale. 196