diff options
Diffstat (limited to 'devdocs/c/string%2Fbyte%2Fstrtoimax.html')
| -rw-r--r-- | devdocs/c/string%2Fbyte%2Fstrtoimax.html | 78 |
1 files changed, 78 insertions, 0 deletions
diff --git a/devdocs/c/string%2Fbyte%2Fstrtoimax.html b/devdocs/c/string%2Fbyte%2Fstrtoimax.html new file mode 100644 index 00000000..2e199efe --- /dev/null +++ b/devdocs/c/string%2Fbyte%2Fstrtoimax.html @@ -0,0 +1,78 @@ + <h1 id="firstHeading" class="firstHeading">strtoimax, strtoumax</h1> <table class="t-dcl-begin"> <tr class="t-dsc-header"> <th> Defined in header <code><inttypes.h></code> </th> <th> </th> <th> </th> </tr> <tr class="t-dcl t-since-c99"> <td> <pre data-language="c">intmax_t strtoimax( const char *restrict nptr, + char **restrict endptr, int base );</pre> +</td> <td class="t-dcl-nopad"> </td> <td> <span class="t-mark-rev t-since-c99">(since C99)</span> </td> </tr> <tr class="t-dcl t-since-c99"> <td> <pre data-language="c">uintmax_t strtoumax( const char *restrict nptr, + char **restrict endptr, int base );</pre> +</td> <td class="t-dcl-nopad"> </td> <td> <span class="t-mark-rev t-since-c99">(since C99)</span> </td> </tr> </table> <p>Interprets an integer value in a byte string pointed to by <code>nptr</code>.</p> +<p>Discards any whitespace characters (as identified by calling <a href="isspace" title="c/string/byte/isspace"><code>isspace</code></a>) until the first non-whitespace character is found, then takes as many characters as possible to form a valid <i>base-n</i> (where n=<code>base</code>) integer number representation and converts them to an integer value. The valid integer value consists of the following parts:</p> +<ul> +<li> <span class="t-mark">(optional)</span> plus or minus sign </li> +<li> <span class="t-mark">(optional)</span> prefix (<code>0</code>) indicating octal base (applies only when the base is <code>8</code> or <code>0</code>) </li> +<li> <span class="t-mark">(optional)</span> prefix (<code>0x</code> or <code>0X</code>) indicating hexadecimal base (applies only when the base is <code>16</code> or <code>0</code>) </li> +<li> a sequence of digits </li> +</ul> <p>The set of valid values for base is <code>{0,2,3,...,36}.</code> The set of valid digits for base-<code>2</code> integers is <code>{0,1},</code> for base-<code>3</code> integers is <code>{0,1,2},</code> and so on. For bases larger than <code>10</code>, valid digits include alphabetic characters, starting from <code>Aa</code> for base-<code>11</code> integer, to <code>Zz</code> for base-<code>36</code> integer. The case of the characters is ignored.</p> +<p>Additional numeric formats may be accepted by the currently installed C <a href="../../locale/setlocale" title="c/locale/setlocale">locale</a>.</p> +<p>If the value of <code>base</code> is <code>0</code>, the numeric base is auto-detected: if the prefix is <code>0</code>, the base is octal, if the prefix is <code>0x</code> or <code>0X</code>, the base is hexadecimal, otherwise the base is decimal.</p> +<p>If the minus sign was part of the input sequence, the numeric value calculated from the sequence of digits is negated as if by <a href="../../language/operator_arithmetic#Unary_arithmetic" title="c/language/operator arithmetic">unary minus</a> in the result type.</p> +<p>The functions sets the pointer pointed to by <code>endptr</code> to point to the character past the last character interpreted. If <code>endptr</code> is a null pointer, it is ignored.</p> +<p>If the <code>nptr</code> is empty or does not have the expected form, no conversion is performed, and (if <code>endptr</code> is not a null pointer) the value of <code>nptr</code> is stored in the object pointed to by <code>endptr</code>.</p> +<h3 id="Parameters"> Parameters</h3> <table class="t-par-begin"> <tr class="t-par"> <td> nptr </td> <td> - </td> <td> pointer to the null-terminated byte string to be interpreted </td> +</tr> <tr class="t-par"> <td> endptr </td> <td> - </td> <td> pointer to a pointer to character. </td> +</tr> <tr class="t-par"> <td> base </td> <td> - </td> <td> <i>base</i> of the interpreted integer value </td> +</tr> +</table> <h3 id="Return_value"> Return value</h3> <ul> +<li> If successful, an integer value corresponding to the contents of <code>str</code> is returned. </li> +<li> If the converted value falls out of range of corresponding return type, a range error occurs (setting <code><a href="../../error/errno" title="c/error/errno">errno</a></code> to <code><a href="../../error/errno_macros" title="c/error/errno macros">ERANGE</a></code>) and <code><a href="../../types/integer" title="c/types/integer">INTMAX_MAX</a></code>, <code><a href="../../types/integer" title="c/types/integer">INTMAX_MIN</a></code>, <code><a href="../../types/integer" title="c/types/integer">UINTMAX_MAX</a></code> or <code>0</code> is returned, as appropriate. </li> +<li> If no conversion can be performed, <code>0</code> is returned. </li> +</ul> <h3 id="Example"> Example</h3> <div class="t-example"> <div class="c source-c"><pre data-language="c">#include <errno.h> +#include <inttypes.h> +#include <stdio.h> +#include <string.h> + +int main(void) +{ + char* endptr; + + printf("%ld\n", strtoimax(" -123junk",&endptr,10)); /* base 10 */ + printf("%ld\n", strtoimax("11111111",&endptr,2)); /* base 2 */ + printf("%ld\n", strtoimax("XyZ",&endptr,36)); /* base 36 */ + printf("%ld\n", strtoimax("010",&endptr,0)); /* octal auto-detection */ + printf("%ld\n", strtoimax("10",&endptr,0)); /* decimal auto-detection */ + printf("%ld\n", strtoimax("0x10",&endptr,0)); /* hexadecimal auto-detection */ + + /* range error */ + /* LONG_MAX+1 --> LONG_MAX */ + errno = 0; + printf("%ld\n", strtoimax("9223372036854775808",&endptr,10)); + printf("%s\n", strerror(errno)); + + return 0; +}</pre></div> <p>Output:</p> +<div class="text source-text"><pre data-language="c">-123 +255 +44027 +8 +10 +16 +9223372036854775807 +Numerical result out of range</pre></div> </div> <h3 id="References"> References</h3> <ul> +<li> C23 standard (ISO/IEC 9899:2023): </li> +<ul><li> 7.8.2.3 The strtoimax and strtoumax functions (p: TBD) </li></ul> +<li> C17 standard (ISO/IEC 9899:2018): </li> +<ul><li> 7.8.2.3 The strtoimax and strtoumax functions (p: TBD) </li></ul> +<li> C11 standard (ISO/IEC 9899:2011): </li> +<ul><li> 7.8.2.3 The strtoimax and strtoumax functions (p: 219) </li></ul> +<li> C99 standard (ISO/IEC 9899:1999): </li> +<ul><li> 7.8.2.3 The strtoimax and strtoumax functions (p: 200) </li></ul> +</ul> <h3 id="See_also"> See also</h3> <table class="t-dsc-begin"> <tr class="t-dsc"> <td> <div><a href="../wide/wcstoimax" title="c/string/wide/wcstoimax"> <span class="t-lines"><span>wcstoimax</span><span>wcstoumax</span></span></a></div> +<div><span class="t-lines"><span><span class="t-mark-rev t-since-c99">(C99)</span></span><span><span class="t-mark-rev t-since-c99">(C99)</span></span></span></div> </td> <td> converts a wide string to <code><a href="http://en.cppreference.com/w/c/types/integer"><span class="kw118">intmax_t</span></a></code> or <code><a href="http://en.cppreference.com/w/c/types/integer"><span class="kw132">uintmax_t</span></a></code> <br> <span class="t-mark">(function)</span> </td> +</tr> <tr class="t-dsc"> <td> <div><a href="strtol" title="c/string/byte/strtol"> <span class="t-lines"><span>strtol</span><span>strtoll</span></span></a></div> +<div><span class="t-lines"><span><span class="t-mark-rev t-since-c99">(C99)</span></span></span></div> </td> <td> converts a byte string to an integer value <br> <span class="t-mark">(function)</span> </td> +</tr> <tr class="t-dsc"> <td> <div><a href="strtoul" title="c/string/byte/strtoul"> <span class="t-lines"><span>strtoul</span><span> strtoull</span></span></a></div> +<div><span class="t-lines"><span><span class="t-mark-rev t-since-c99">(C99)</span></span></span></div> </td> <td> converts a byte string to an unsigned integer value <br> <span class="t-mark">(function)</span> </td> +</tr> <tr class="t-dsc"> <td colspan="2"> <span><a href="https://en.cppreference.com/w/cpp/string/byte/strtoimax" title="cpp/string/byte/strtoimax">C++ documentation</a></span> for <code>strtoimax, strtoumax</code> </td> +</tr> </table> <div class="_attribution"> + <p class="_attribution-p"> + © cppreference.com<br>Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.<br> + <a href="https://en.cppreference.com/w/c/string/byte/strtoimax" class="_attribution-link">https://en.cppreference.com/w/c/string/byte/strtoimax</a> + </p> +</div> |