man-pages/man3p/strtoimax.3p

79 lines
2.3 KiB
Plaintext

.\" Copyright (c) 2001-2003 The Open Group, All Rights Reserved
.TH "STRTOIMAX" 3P 2003 "IEEE/The Open Group" "POSIX Programmer's Manual"
.\" strtoimax
.SH NAME
strtoimax, strtoumax \- convert string to integer type
.SH SYNOPSIS
.LP
\fB#include <inttypes.h>
.br
.sp
intmax_t strtoimax(const char *restrict\fP \fInptr\fP\fB, char **restrict\fP
\fIendptr\fP\fB,
.br
\ \ \ \ \ \ int\fP \fIbase\fP\fB);
.br
uintmax_t strtoumax(const char *restrict\fP \fInptr\fP\fB, char **restrict\fP
\fIendptr\fP\fB,
.br
\ \ \ \ \ \ int\fP \fIbase\fP\fB);
.br
\fP
.SH DESCRIPTION
.LP
These functions shall be equivalent to the \fIstrtol\fP(), \fIstrtoll\fP(),
\fIstrtoul\fP(), and \fIstrtoull\fP() functions, except that the initial
portion of the string shall be converted to
\fBintmax_t\fP and \fBuintmax_t\fP representation, respectively.
.SH RETURN VALUE
.LP
These functions shall return the converted value, if any.
.LP
If no conversion could be performed, zero shall be returned.
.LP
If the correct value is outside the range of representable values,
{INTMAX_MAX}, {INTMAX_MIN}, or {UINTMAX_MAX} shall be
returned (according to the return type and sign of the value, if any),
and \fIerrno\fP shall be set to [ERANGE].
.SH ERRORS
.LP
These functions shall fail if:
.TP 7
.B ERANGE
The value to be returned is not representable.
.sp
.LP
These functions may fail if:
.TP 7
.B EINVAL
The value of \fIbase\fP is not supported.
.sp
.LP
\fIThe following sections are informative.\fP
.SH EXAMPLES
.LP
None.
.SH APPLICATION USAGE
.LP
None.
.SH RATIONALE
.LP
None.
.SH FUTURE DIRECTIONS
.LP
None.
.SH SEE ALSO
.LP
\fIstrtol\fP() , \fIstrtoul\fP() , the Base Definitions volume of
IEEE\ Std\ 1003.1-2001, \fI<inttypes.h>\fP
.SH COPYRIGHT
Portions of this text are reprinted and reproduced in electronic form
from IEEE Std 1003.1, 2003 Edition, Standard for Information Technology
-- Portable Operating System Interface (POSIX), The Open Group Base
Specifications Issue 6, Copyright (C) 2001-2003 by the Institute of
Electrical and Electronics Engineers, Inc and The Open Group. In the
event of any discrepancy between this version 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 .