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

wcrtomb.3p (4119B)

    

  1. '\" et
  2. .TH WCRTOMB "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. wcrtomb
  12. \(em convert a wide-character code to a character (restartable)
  13. .SH SYNOPSIS
  14. .LP
  15. .nf
  16. #include <wchar.h>
  17. .P
  18. size_t wcrtomb(char *restrict \fIs\fP, wchar_t \fIwc\fP, mbstate_t *restrict \fIps\fP);
  19. .fi
  20. .SH DESCRIPTION
  21. The functionality described on this reference page is aligned with the
  22. ISO\ C standard. Any conflict between the requirements described here and the
  23. ISO\ C standard is unintentional. This volume of POSIX.1\(hy2017 defers to the ISO\ C standard.
  24. .P
  25. If
  26. .IR s
  27. is a null pointer, the
  28. \fIwcrtomb\fR()
  29. function shall be equivalent to the call:
  30. .sp
  31. .RS 4
  32. .nf
  34. wcrtomb(\fIbuf\fP, L\(aq\e0\(aq, \fIps\fP)
  35. .fi
  36. .P
  37. .RE
  38. .P
  39. where
  40. .IR buf
  41. is an internal buffer.
  42. .P
  43. If
  44. .IR s
  45. is not a null pointer, the
  46. \fIwcrtomb\fR()
  47. function shall determine the number of bytes needed to represent the
  48. character that corresponds to the wide character given by
  49. .IR wc
  50. (including any shift sequences), and store the resulting bytes in the
  51. array whose first element is pointed to by
  52. .IR s .
  53. At most
  54. {MB_CUR_MAX}
  55. bytes are stored. If
  56. .IR wc
  57. is a null wide character, a null byte shall be stored, preceded by any
  58. shift sequence needed to restore the initial shift state. The resulting
  59. state described shall be the initial conversion state.
  60. .P
  61. If
  62. .IR ps
  63. is a null pointer, the
  64. \fIwcrtomb\fR()
  65. function shall use its own internal
  66. .BR mbstate_t
  67. object, which is initialized at program start-up to the initial
  68. conversion state. Otherwise, the
  69. .BR mbstate_t
  70. object pointed to by
  71. .IR ps
  72. shall be used to completely describe the current conversion state of
  73. the associated character sequence. The implementation shall behave as
  74. if no function defined in this volume of POSIX.1\(hy2017 calls
  75. \fIwcrtomb\fR().
  76. .P
  77. The
  78. \fIwcrtomb\fR()
  79. function need not be thread-safe if called with a NULL
  80. .IR ps
  81. argument.
  82. .P
  83. The behavior of this function shall be affected by the
  84. .IR LC_CTYPE
  85. category of the current locale.
  86. .P
  87. The
  88. \fIwcrtomb\fR()
  89. function shall not change the setting of
  90. .IR errno
  91. if successful.
  92. .SH "RETURN VALUE"
  93. The
  94. \fIwcrtomb\fR()
  95. function shall return the number of bytes stored in the array object
  96. (including any shift sequences). When
  97. .IR wc
  98. is not a valid wide character, an encoding error shall occur. In this
  99. case, the function shall store the value of the macro
  100. .BR [EILSEQ] 
  101. in
  102. .IR errno
  103. and shall return (\fBsize_t\fP)\-1; the conversion state shall be
  104. undefined.
  105. .SH ERRORS
  106. The
  107. \fIwcrtomb\fR()
  108. function shall fail if:
  109. .TP
  110. .BR EILSEQ
  111. An invalid wide-character code is detected.
  112. .P
  113. The
  114. \fIwcrtomb\fR()
  115. function may fail if:
  116. .TP
  117. .BR EINVAL
  118. .IR ps
  119. points to an object that contains an invalid conversion state.
  120. .LP
  121. .IR "The following sections are informative."
  122. .SH EXAMPLES
  123. None.
  124. .SH "APPLICATION USAGE"
  125. None.
  126. .SH RATIONALE
  127. None.
  128. .SH "FUTURE DIRECTIONS"
  129. None.
  130. .SH "SEE ALSO"
  131. .IR "\fImbsinit\fR\^(\|)",
  132. .IR "\fIwcsrtombs\fR\^(\|)"
  133. .P
  134. The Base Definitions volume of POSIX.1\(hy2017,
  135. .IR "\fB<wchar.h>\fP"
  136. .\"
  137. .SH COPYRIGHT
  138. Portions of this text are reprinted and reproduced in electronic form
  139. from IEEE Std 1003.1-2017, Standard for Information Technology
  140. -- Portable Operating System Interface (POSIX), The Open Group Base
  141. Specifications Issue 7, 2018 Edition,
  142. Copyright (C) 2018 by the Institute of
  143. Electrical and Electronics Engineers, Inc and The Open Group.
  144. In the event of any discrepancy between this version and the original IEEE and
  145. The Open Group Standard, the original IEEE and The Open Group Standard
  146. is the referee document. The original Standard can be obtained online at
  147. http://www.opengroup.org/unix/online.html .
  148. .PP
  149. Any typographical or formatting errors that appear
  150. in this page are most likely
  151. to have been introduced during the conversion of the source files to
  152. man page format. To report such errors, see
  153. https://www.kernel.org/doc/man-pages/reporting_bugs.html .