wcstoimax(3p) — Linux manual page

WCSTOIMAX(3P)           POSIX Programmer's Manual          WCSTOIMAX(3P)

PROLOG

       This manual page is part of the POSIX Programmer's Manual.  The
       Linux implementation of this interface may differ (consult the
       corresponding Linux manual page for details of Linux behavior),
       or the interface may not be implemented on Linux.

NAME

       wcstoimax, wcstoumax — convert a wide-character string to an
       integer type

SYNOPSIS

       #include <stddef.h>
       #include <inttypes.h>

       intmax_t wcstoimax(const wchar_t *restrict nptr,
           wchar_t **restrict endptr, int base);
       uintmax_t wcstoumax(const wchar_t *restrict nptr,
           wchar_t **restrict endptr, int base);

DESCRIPTION

       The functionality described on this reference page is aligned
       with the ISO C standard. Any conflict between the requirements
       described here and the ISO C standard is unintentional. This
       volume of POSIX.1‐2017 defers to the ISO C standard.

       These functions shall be equivalent to the wcstol(), wcstoll(),
       wcstoul(), and wcstoull() functions, respectively, except that
       the initial portion of the wide string shall be converted to
       intmax_t and uintmax_t representation, respectively.

RETURN VALUE

       These functions shall return the converted value, if any.

       If no conversion could be performed, zero shall be returned. 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
       errno shall be set to [ERANGE].

ERRORS

       These functions shall fail if:

       EINVAL The value of base is not supported.

       ERANGE The value to be returned is not representable.

       These functions may fail if:

       EINVAL No conversion could be performed.

       The following sections are informative.

EXAMPLES

       None.

APPLICATION USAGE

       None.

RATIONALE

       None.

FUTURE DIRECTIONS

       None.

SEE ALSO

       wcstol(3p), wcstoul(3p)

       The Base Definitions volume of POSIX.1‐2017, inttypes.h(0p),
       stddef.h(0p)

COPYRIGHT

       Portions of this text are reprinted and reproduced in electronic
       form from IEEE Std 1003.1-2017, Standard for Information
       Technology -- Portable Operating System Interface (POSIX), The
       Open Group Base Specifications Issue 7, 2018 Edition, Copyright
       (C) 2018 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 .

       Any typographical or formatting errors that appear in this page
       are most likely to have been introduced during the conversion of
       the source files to man page format. To report such errors, see
       https://www.kernel.org/doc/man-pages/reporting_bugs.html .

IEEE/The Open Group               2017                     WCSTOIMAX(3P)

Pages that refer to this page: inttypes.h(0p), wcstoumax(3p)

---