lib/libc/stdlib/strtoul.3

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