1 .\" $DragonFly: src/lib/libc/stdlib/strtonum.3,v 1.6 2007/08/18 20:48:47 swildner Exp $
2 .\" $OpenBSD: strtonum.3,v 1.13 2006/04/25 05:15:42 tedu Exp $
4 .\" Copyright (c) 2004 Ted Unangst
6 .\" Permission to use, copy, modify, and distribute this software for any
7 .\" purpose with or without fee is hereby granted, provided that the above
8 .\" copyright notice and this permission notice appear in all copies.
10 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
23 .Nd "reliably convert string value to an integer"
30 .Fa "const char *nptr"
31 .Fa "long long minval"
32 .Fa "long long maxval"
33 .Fa "const char **errstr"
38 function converts the string in
45 function was designed to facilitate safe, robust programming
46 and overcome the shortcomings of the
52 The string may begin with an arbitrary amount of whitespace
55 followed by a single optional
61 The remainder of the string is converted to a
63 value according to base 10.
65 The value obtained is then checked against the provided
74 stores an error string in
76 indicating the failure.
80 function returns the result of the conversion,
81 unless the value would exceed the provided bounds or is invalid.
82 On error, 0 is returned,
86 will point to an error message.
91 this fact can be used to differentiate
92 a successful return of 0 from an error.
96 correctly is meant to be simpler than the alternative functions.
97 .Bd -literal -offset indent
101 iterations = strtonum(optarg, 1, 64, &errstr);
103 errx(1, "number of iterations is %s: %s", errstr, optarg);
106 The above example will guarantee that the value of iterations is between
107 1 and 64 (inclusive).
111 The given string was out of range.
113 The given string did not consist solely of digit characters.
122 will be set to one of the following strings:
124 .Bl -tag -width "too largeXX" -compact
126 The result was larger than the provided maximum value.
128 The result was smaller than the provided minimum value.
130 The string did not consist solely of digit characters.
143 was originally implemented as an extension on
145 The existing alternatives, such as
149 are either impossible or difficult to use safely.