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