1 .\" Copyright (c) 1990, 1991, 1993
2 .\" The Regents of the University of California. All rights reserved.
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.
8 .\" Redistribution and use in source and binary forms, with or without
9 .\" modification, are permitted provided that the following conditions
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 .\" 4. Neither the name of the University nor the names of its contributors
17 .\" may be used to endorse or promote products derived from this software
18 .\" without specific prior written permission.
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .\" @(#)strtoul.3 8.1 (Berkeley) 6/4/93
33 .\" $FreeBSD: src/lib/libc/stdlib/strtoul.3,v 1.23 2007/01/09 00:28:10 imp Exp $
34 .\" $DragonFly: src/lib/libc/stdlib/strtoul.3,v 1.4 2006/11/02 19:48:55 swildner Exp $
44 .Nd "convert a string to an"
45 .Vt "unsigned long" , "unsigned long long" , uintmax_t ,
55 .Fn strtoul "const char * restrict nptr" "char ** restrict endptr" "int base"
56 .Ft "unsigned long long"
57 .Fn strtoull "const char * restrict nptr" "char ** restrict endptr" "int base"
60 .Fn strtoumax "const char * restrict nptr" "char ** restrict endptr" "int base"
65 .Fn strtouq "const char *nptr" "char **endptr" "int base"
70 converts the string in
78 converts the string in
81 .Vt "unsigned long long"
86 converts the string in
94 converts the string in
99 The conversion is done according to the given
101 which must be between 2 and 36 inclusive,
102 or be the special value 0.
104 The string may begin with an arbitrary amount of white space
107 followed by a single optional
115 the string may then include a
118 and the number will be read in base 16; otherwise, a zero
120 is taken as 10 (decimal) unless the next character is
122 in which case it is taken as 8 (octal).
124 The remainder of the string is converted to an
126 value in the obvious manner,
127 stopping at the end of the string
128 or at the first character that does not produce a valid digit
130 (In bases above 10, the letter
132 in either upper or lower case
135 represents 11, and so forth, with
144 stores the address of the first invalid character in
146 If there were no digits at all, however,
148 stores the original value of
160 on return, the entire string was valid.)
169 return either the result of the conversion
170 or, if there was a leading minus sign,
171 the negation of the result of the conversion,
172 unless the original (non-negated) value would overflow;
191 If no conversion could be performed, 0 is returned and
196 (the last feature is not portable across all platforms).
203 no conversion could be performed
204 (the last feature is not portable across all platforms).
206 The given string was out of range; the value converted has been clamped.
228 function is deprecated.