logo

oasis-root

Compiled tree of Oasis Linux based on own branch at <https://hacktivis.me/git/oasis/> git clone https://anongit.hacktivis.me/git/oasis-root.git

wcstoimax.3p (3067B)

    

  1. '\" et
  2. .TH WCSTOIMAX "3P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual"
  3. .\"
  4. .SH PROLOG
  5. This manual page is part of the POSIX Programmer's Manual.
  6. The Linux implementation of this interface may differ (consult
  7. the corresponding Linux manual page for details of Linux behavior),
  8. or the interface may not be implemented on Linux.
  9. .\"
  10. .SH NAME
  11. wcstoimax,
  12. wcstoumax
  13. \(em convert a wide-character string to an integer type
  14. .SH SYNOPSIS
  15. .LP
  16. .nf
  17. #include <stddef.h>
  18. #include <inttypes.h>
  19. .P
  20. intmax_t wcstoimax(const wchar_t *restrict \fInptr\fP,
  21.     wchar_t **restrict \fIendptr\fP, int \fIbase\fP);
  22. uintmax_t wcstoumax(const wchar_t *restrict \fInptr\fP,
  23.     wchar_t **restrict \fIendptr\fP, int \fIbase\fP);
  24. .fi
  25. .SH DESCRIPTION
  26. The functionality described on this reference page is aligned with the
  27. ISO\ C standard. Any conflict between the requirements described here and the
  28. ISO\ C standard is unintentional. This volume of POSIX.1\(hy2017 defers to the ISO\ C standard.
  29. .P
  30. These functions shall be equivalent to the
  31. \fIwcstol\fR(),
  32. \fIwcstoll\fR(),
  33. \fIwcstoul\fR(),
  34. and
  35. \fIwcstoull\fR()
  36. functions, respectively, except that the initial portion of the wide
  37. string shall be converted to
  38. .BR intmax_t
  39. and
  40. .BR uintmax_t
  41. representation, respectively.
  42. .SH "RETURN VALUE"
  43. These functions shall return the converted value, if any.
  44. .P
  45. If no conversion could be performed, zero shall be returned. If the
  46. correct value is outside the range of representable values,
  47. {INTMAX_MAX},
  48. {INTMAX_MIN},
  49. or
  50. {UINTMAX_MAX}
  51. shall be returned (according to the return type and sign of the value,
  52. if any), and
  53. .IR errno
  54. shall be set to
  55. .BR [ERANGE] .
  56. .SH ERRORS
  57. These functions shall fail if:
  58. .TP
  59. .BR EINVAL
  60. The value of
  61. .IR base
  62. is not supported.
  63. .TP
  64. .BR ERANGE
  65. The value to be returned is not representable.
  66. .P
  67. These functions may fail if:
  68. .TP
  69. .BR EINVAL
  70. No conversion could be performed.
  71. .LP
  72. .IR "The following sections are informative."
  73. .SH EXAMPLES
  74. None.
  75. .SH "APPLICATION USAGE"
  76. None.
  77. .SH RATIONALE
  78. None.
  79. .SH "FUTURE DIRECTIONS"
  80. None.
  81. .SH "SEE ALSO"
  82. .IR "\fIwcstol\fR\^(\|)",
  83. .IR "\fIwcstoul\fR\^(\|)"
  84. .P
  85. The Base Definitions volume of POSIX.1\(hy2017,
  86. .IR "\fB<inttypes.h>\fP",
  87. .IR "\fB<stddef.h>\fP"
  88. .\"
  89. .SH COPYRIGHT
  90. Portions of this text are reprinted and reproduced in electronic form
  91. from IEEE Std 1003.1-2017, Standard for Information Technology
  92. -- Portable Operating System Interface (POSIX), The Open Group Base
  93. Specifications Issue 7, 2018 Edition,
  94. Copyright (C) 2018 by the Institute of
  95. Electrical and Electronics Engineers, Inc and The Open Group.
  96. In the event of any discrepancy between this version and the original IEEE and
  97. The Open Group Standard, the original IEEE and The Open Group Standard
  98. is the referee document. The original Standard can be obtained online at
  99. http://www.opengroup.org/unix/online.html .
  100. .PP
  101. Any typographical or formatting errors that appear
  102. in this page are most likely
  103. to have been introduced during the conversion of the source files to
  104. man page format. To report such errors, see
  105. https://www.kernel.org/doc/man-pages/reporting_bugs.html .