STRTOIMAX(3P)

🌸 PROLOG 🌸

okay so before we even get into it β€” this manual page is part of the POSIX Programmer's Manual (yes, the whole STRTOIMAX(3P) situation, bestie). Heads up tho: the Linux implementation of this interface may differ, so if you're on Linux, go consult the corresponding Linux manual page for the actual tea on Linux behavior. OR β€” plot twist β€” the interface might not even be implemented on Linux at all. πŸ™ˆ


✨ 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 πŸ¦‹

okay so the functionality described on this reference page is aligned with the ISO C standard. And like, if there's any conflict between what's written here and the ISO C standard? That's unintentional, not a vibe. This volume of POSIX.1‐2017 defers to the ISO C standard, periodt.

So these functions shall be equivalent to the strtol(), strtoll(), strtoul(), and strtoull() functions β€” except that the initial portion of the string shall be converted to intmax_t and uintmax_t representation, respectively. That's the whole glow-up. 🌟


πŸ’– 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 errno may be set to [EINVAL].
  • If the value of base is not supported, 0 shall be returned and errno shall be set to [EINVAL].
  • 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].
ngl that ERANGE one is giving "your number was too iconic for this container" 😭

πŸ”₯ 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. 🫢 (yes really, nothing, we move.)


πŸ’œ APPLICATION USAGE πŸ’œ

okay this part actually matters so listen up bestie: since the value of *endptr is unspecified if the value of base is not supported, applications should either

  • make sure base has a supported value (0 or between 2 and 36) before the call, or
  • check for an [EINVAL] error before examining *endptr.

like, don't go reading *endptr when you haven't done your homework first. that's the vibe check. ⭐


🧚 RATIONALE 🧚

None.


πŸ“ FUTURE DIRECTIONS πŸ“

None.


πŸ‘‘ SEE ALSO πŸ‘‘

  • strtol(), strtoul()

The Base Definitions volume of POSIX.1‐2017, <inttypes.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, 2017 (the STRTOIMAX(3P) footer era πŸ’…βœ¨) stay parsing, stay iconic πŸ‘‘πŸ¦‹

πŸ“¦ where this page comes from