xref: /illumos-gate/usr/src/man/man3c/strtoimax.3c (revision 2a6e99a0f1f7d22c0396e8b2ce9b9babbd1056cf)

Sun Microsystems, Inc. gratefully acknowledges The Open Group for
permission to reproduce portions of its copyrighted documentation.
Original documentation from The Open Group can be obtained online at
http://www.opengroup.org/bookstore/.

The Institute of Electrical and Electronics Engineers and The Open
Group, have given us permission to reprint portions of their
documentation.

In the following statement, the phrase ``this text'' refers to portions
of the system documentation.

Portions of this text are reprinted and reproduced in electronic form
in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
Standard for Information Technology -- Portable Operating System
Interface (POSIX), The Open Group Base Specifications Issue 6,
Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
Engineers, Inc and The Open Group. In the event of any discrepancy
between these versions and the original IEEE and The Open Group
Standard, the original IEEE and The Open Group Standard is the referee
document. The original Standard can be obtained online at
http://www.opengroup.org/unix/online.html.

This notice shall appear on any product containing this material.

The contents of this file are subject to the terms of the
Common Development and Distribution License (the "License").
You may not use this file except in compliance with the License.

You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
or http://www.opensolaris.org/os/licensing.
See the License for the specific language governing permissions
and limitations under the License.

When distributing Covered Code, include this CDDL HEADER in each
file and include the License file at usr/src/OPENSOLARIS.LICENSE.
If applicable, add the following below this CDDL HEADER, with the
fields enclosed by brackets "[]" replaced with your own identifying
information: Portions Copyright [yyyy] [name of copyright owner]


Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved.
Portions Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved.

STRTOIMAX 3C "Nov 1, 2003"
NAME
strtoimax, strtoumax - convert string to integer type
SYNOPSIS

#include <inttypes.h>

intmax_t strtoimax(const char *restrict nptr,
 char **restrict endptr, int base);

uintmax_t strtoumax(const char *restrict nptr,
 char **restrict endptr, int base);
DESCRIPTION

These functions are equivalent to the strtol(), strtoll(), strtoul(), and strtoull() functions, except that the initial portion of the string is converted to intmax_t and uintmax_t representation, respectively.

RETURN VALUES

These functions return the converted value, if any.

If no conversion could be performed, 0 is returned.

If the correct value is outside the range of representable values, {INTMAX_MAX}, {INTMAX_MIN}, or {UINTMAX_MAX} is returned (according to the return type and sign of the value, if any), and errno is set to ERANGE.

ERRORS

These functions will fail if: ERANGE

The value to be returned is not representable.

These functions may fail if: EINVAL

The value of base is not supported.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Standard
MT-Level MT-Safe
SEE ALSO

strtol(3C), strtoul(3C), attributes(5), standards(5)