Home | History | Annotate | Line # | Download | only in stdlib
strsuftoll.3 revision 1.4
 $NetBSD: strsuftoll.3,v 1.4 2004/02/13 17:56:17 wiz Exp $

Copyright (c) 2002 The NetBSD Foundation, Inc.
All rights reserved.

This code is derived from software contributed to The NetBSD Foundation
by Luke Mewburn.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
3. All advertising materials mentioning features or use of this software
must display the following acknowledgement:
This product includes software developed by the NetBSD
Foundation, Inc. and its contributors.
4. Neither the name of The NetBSD Foundation nor the names of its
contributors may be used to endorse or promote products derived
from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.

.Dd November 29, 2002 .Dt STRSUFTOLL 3 .Os .Sh NAME .Nm strsuftoll , .Nm strsuftollx .Nd "convert a string to a long long, with suffix parsing" .Sh LIBRARY .Lb libc .Sh SYNOPSIS n stdlib.h .Ft long long .Fn strsuftoll "const char *desc" "const char *val" "long long min" "long long max" .Ft long long .Fn strsuftollx "const char *desc" "const char *val" "long long min" "long long max" "char *errbuf" "size_t errbuflen" .Sh DESCRIPTION The functions .Fn strsuftoll and .Fn strsuftollx convert .Fa val into a long long number, checking that the result is not smaller than .Fa min or larger than .Fa max . Two or more numbers may be separated by an .Dq x to indicate a product. Each number may have one of the following optional suffixes: l -tag -width 3n -offset indent -compact t b Block; multiply by 512 t k Kilo; multiply by 1024 (1 KB) t m Mega; multiply by 1048576 (1 MB) t g Giga; multiply by 1073741824 (1 GB) t t Tera; multiply by 1099511627776 (1 TB) t w Word; multiply by the number of bytes in an integer .El

p In the case of an error (range overflow or an invalid number), .Fn strsuftollx places an error message into .Fa errbuf (which is .Fa errbuflen bytes long) and returns 0, and .Fn strsuftoll displays that error and terminates the process. .Sh RETURN VALUES The functions .Fn strsuftoll and .Fn strsuftollx return either the result of the conversion, unless the value overflows or is not a number; in the latter case, .Fn strsuftoll displays an error message and terminates the process with exit code 1, and .Fn strsuftollx returns with 0 and .Fa errbuf contains a non-empty error message. .Sh ERRORS l -tag -width Er t Bq Er ERANGE The given string was out of range; the value converted has been clamped. .El .Sh SEE ALSO .Xr errx 3 , .Xr strtoll 3 .Sh BUGS Ignores the current locale.