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

btowc.3p (2578B)

    

  1. '\" et
  2. .TH BTOWC "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. btowc
  12. \(em single byte to wide character conversion
  13. .SH SYNOPSIS
  14. .LP
  15. .nf
  16. #include <stdio.h>
  17. #include <wchar.h>
  18. .P
  19. wint_t btowc(int \fIc\fP);
  20. .fi
  21. .SH DESCRIPTION
  22. The functionality described on this reference page is aligned with the
  23. ISO\ C standard. Any conflict between the requirements described here and the
  24. ISO\ C standard is unintentional. This volume of POSIX.1\(hy2017 defers to the ISO\ C standard.
  25. .P
  26. The
  27. \fIbtowc\fR()
  28. function shall determine whether
  29. .IR c
  30. constitutes a valid (one-byte) character in the initial shift state.
  31. .P
  32. The behavior of this function shall be affected by the
  33. .IR LC_CTYPE
  34. category of the current locale.
  35. .SH "RETURN VALUE"
  36. The
  37. \fIbtowc\fR()
  38. function shall return WEOF if
  39. .IR c
  40. has the value EOF or if
  41. .BR "(unsigned char)"
  42. .IR c
  43. does not constitute a valid (one-byte) character in the initial shift
  44. state. Otherwise, it shall return the wide-character representation of
  45. that character.
  46. .P
  47. In the POSIX locale,
  48. \fIbtowc\fR()
  49. shall not return WEOF if
  50. .IR c
  51. has a value in the range 0 to 255 inclusive.
  52. .SH ERRORS
  53. No errors are defined.
  54. .LP
  55. .IR "The following sections are informative."
  56. .SH EXAMPLES
  57. None.
  58. .SH "APPLICATION USAGE"
  59. None.
  60. .SH RATIONALE
  61. None.
  62. .SH "FUTURE DIRECTIONS"
  63. None.
  64. .SH "SEE ALSO"
  65. .IR "\fIwctob\fR\^(\|)"
  66. .P
  67. The Base Definitions volume of POSIX.1\(hy2017,
  68. .IR "\fB<stdio.h>\fP",
  69. .IR "\fB<wchar.h>\fP"
  70. .\"
  71. .SH COPYRIGHT
  72. Portions of this text are reprinted and reproduced in electronic form
  73. from IEEE Std 1003.1-2017, Standard for Information Technology
  74. -- Portable Operating System Interface (POSIX), The Open Group Base
  75. Specifications Issue 7, 2018 Edition,
  76. Copyright (C) 2018 by the Institute of
  77. Electrical and Electronics Engineers, Inc and The Open Group.
  78. In the event of any discrepancy between this version and the original IEEE and
  79. The Open Group Standard, the original IEEE and The Open Group Standard
  80. is the referee document. The original Standard can be obtained online at
  81. http://www.opengroup.org/unix/online.html .
  82. .PP
  83. Any typographical or formatting errors that appear
  84. in this page are most likely
  85. to have been introduced during the conversion of the source files to
  86. man page format. To report such errors, see
  87. https://www.kernel.org/doc/man-pages/reporting_bugs.html .