genericopenlibs/openenvcore/include/inttypes.dosc
changeset 0 e4d67989cc36
equal deleted inserted replaced
-1:000000000000 0:e4d67989cc36
       
     1 /** @file  ../include/inttypes.h
       
     2 @internalComponent
       
     3 */
       
     4 
       
     5 /** @struct imaxdiv_t
       
     6 
       
     7 Includes the following members,
       
     8 
       
     9 @publishedAll
       
    10 @externallyDefinedApi
       
    11 */
       
    12 
       
    13 /** @var imaxdiv_t::quot
       
    14 Quotient
       
    15 */
       
    16 
       
    17 /** @var imaxdiv_t::rem
       
    18 remainder
       
    19 */
       
    20 
       
    21 /** @fn  strtoimax(const char * __restrict nptr, char ** __restrict endptr, int base)
       
    22 @param nptr
       
    23 @param endptr
       
    24 @param base
       
    25 @return These functions shall return the converted value, if any.
       
    26 If no conversion could be performed, zero shall be returned.
       
    27 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].
       
    28 
       
    29 
       
    30 Convert a string to an intmax_t integer.
       
    31 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 representation.
       
    32 
       
    33 
       
    34 @publishedAll
       
    35 @externallyDefinedApi
       
    36 */
       
    37 
       
    38 /** @fn  strtoumax(const char * __restrict nptr, char ** __restrict endptr, int base)
       
    39 @param nptr
       
    40 @param endptr
       
    41 @param base
       
    42 @return These functions shall return the converted value, if any.
       
    43 If no conversion could be performed, zero shall be returned.
       
    44 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].
       
    45 
       
    46 Convert a string to an intmax_t integer.
       
    47 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 uintmax_t representation.
       
    48 
       
    49 
       
    50 
       
    51 @publishedAll
       
    52 @externallyDefinedApi
       
    53 */
       
    54 
       
    55 /** @fn  wcstoimax(const wchar_t * __restrict nptr, wchar_t ** __restrict endptr, int base)
       
    56 @param nptr
       
    57 @param endptr
       
    58 @param base
       
    59 @return     These functions shall return the converted value, if any.
       
    60 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].
       
    61 
       
    62 Convert a wide character string to an intmax_t integer.
       
    63 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 representation.
       
    64 
       
    65 @publishedAll
       
    66 @externallyDefinedApi
       
    67 */
       
    68 
       
    69 /** @fn  wcstoumax(const wchar_t * __restrict nptr, wchar_t ** __restrict endptr, int base)
       
    70 @param nptr
       
    71 @param endptr
       
    72 @param base
       
    73 @return     These functions shall return the converted value, if any.
       
    74 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].
       
    75 
       
    76 Convert a wide character string to an intmax_t integer.
       
    77 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 uintmax_t representation. 
       
    78 
       
    79 @publishedAll
       
    80 @externallyDefinedApi
       
    81 */