WCSTOIMAX(3P)

πŸ‘‘ WCSTOIMAX(3P) β€” the POSIX Programmer's Manual glow-up πŸ’…

okay bestie, so this page lives in the POSIX Programmer's Manual (the 3P section, we love a portable queen) and it's all about turning wide-character strings into the biggest integer types C has to offer. let's get into it 🫢


🚨 PROLOG 🚨

heads up fr fr: this manual page is part of the POSIX Programmer's Manual. The Linux implementation of this interface may differ (so like, go consult the corresponding Linux manual page for the deets on Linux behavior), or honestly the interface may not even be implemented on Linux. iykyk πŸ’€

✨ 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 β€” not us being messy on purpose, promise. This volume of POSIX.1‐2017 defers to the ISO C standard. periodt.

So here's the tea πŸ“: 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. it's giving biggest-integer-energy ✨


πŸ”₯ RETURN VALUE πŸ”₯

These functions shall return the converted value, if any. simple as that πŸ’…

If no conversion could be performed, zero shall be returned. and if the correct value is outside the range of representable values, then {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]. she's overflowing, your honor 😭


πŸ’€ ERRORS πŸ’€

These functions shall fail if:

  • EINVAL β€” the value of base is not supported. not the base we ordered, bestie πŸ™ˆ
  • ERANGE β€” the value to be returned is not representable. too big, too small, too much 😭

These functions may fail if:

  • EINVAL β€” no conversion could be performed.

The following sections are informative β€” aka the bonus lore πŸ¦‹


🌈 EXAMPLES 🌈

None. yes literally none, we're not hiding anything 🧚


🌸 APPLICATION USAGE 🌸

None. again, nothing, it's a clean page bestie ✨


πŸ¦‹ RATIONALE πŸ¦‹

None. no rationale, no drama πŸ’œ


⭐ FUTURE DIRECTIONS ⭐

None. the future is, apparently, uneventful πŸ‘‘


πŸ”— SEE ALSO πŸ”—

  • wcstol()
  • wcstoul()
  • The Base Definitions volume of POSIX.1‐2017, <inttypes.h>, <stddef.h>

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 .


and that's the whole page, bestie β€” brought to you by IEEE/The Open Group, dated 2017, filed under WCSTOIMAX(3P). slay, go convert some wide strings πŸ’–βœ¨

πŸ“¦ where this page comes from