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

mbsinit.3p (3329B)

    

  1. '\" et
  2. .TH MBSINIT "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. mbsinit
  12. \(em determine conversion object status
  13. .SH SYNOPSIS
  14. .LP
  15. .nf
  16. #include <wchar.h>
  17. .P
  18. int mbsinit(const mbstate_t *\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 ps
  27. is not a null pointer, the
  28. \fImbsinit\fR()
  29. function shall determine whether the object pointed to by
  30. .IR ps
  31. describes an initial conversion state.
  32. .SH "RETURN VALUE"
  33. The
  34. \fImbsinit\fR()
  35. function shall return non-zero if
  36. .IR ps
  37. is a null pointer, or if the pointed-to object describes an initial
  38. conversion state; otherwise, it shall return zero.
  39. .P
  40. If an
  41. .BR mbstate_t
  42. object is altered by any of the functions described as ``restartable'',
  43. and is then used with a different character sequence, or in the other
  44. conversion direction, or with a different
  45. .IR LC_CTYPE
  46. category setting than on earlier function calls, the behavior is undefined.
  47. .SH ERRORS
  48. No errors are defined.
  49. .LP
  50. .IR "The following sections are informative."
  51. .SH EXAMPLES
  52. None.
  53. .SH "APPLICATION USAGE"
  54. The
  55. .BR mbstate_t
  56. object is used to describe the current conversion state from a
  57. particular character sequence to a wide-character sequence (or \fIvice
  58. versa\fP) under the rules of a particular setting of the
  59. .IR LC_CTYPE
  60. category of the current locale.
  61. .P
  62. The initial conversion state corresponds, for a conversion in either
  63. direction, to the beginning of a new character sequence in the initial
  64. shift state. A zero valued
  65. .BR mbstate_t
  66. object is at least one way to describe an initial conversion state. A
  67. zero valued
  68. .BR mbstate_t
  69. object can be used to initiate conversion involving any character
  70. sequence, in any
  71. .IR LC_CTYPE
  72. category setting.
  73. .SH RATIONALE
  74. None.
  75. .SH "FUTURE DIRECTIONS"
  76. None.
  77. .SH "SEE ALSO"
  78. .IR "\fImbrlen\fR\^(\|)",
  79. .IR "\fImbrtowc\fR\^(\|)",
  80. .IR "\fImbsrtowcs\fR\^(\|)",
  81. .IR "\fIwcrtomb\fR\^(\|)",
  82. .IR "\fIwcsrtombs\fR\^(\|)"
  83. .P
  84. The Base Definitions volume of POSIX.1\(hy2017,
  85. .IR "\fB<wchar.h>\fP"
  86. .\"
  87. .SH COPYRIGHT
  88. Portions of this text are reprinted and reproduced in electronic form
  89. from IEEE Std 1003.1-2017, Standard for Information Technology
  90. -- Portable Operating System Interface (POSIX), The Open Group Base
  91. Specifications Issue 7, 2018 Edition,
  92. Copyright (C) 2018 by the Institute of
  93. Electrical and Electronics Engineers, Inc and The Open Group.
  94. In the event of any discrepancy between this version and the original IEEE and
  95. The Open Group Standard, the original IEEE and The Open Group Standard
  96. is the referee document. The original Standard can be obtained online at
  97. http://www.opengroup.org/unix/online.html .
  98. .PP
  99. Any typographical or formatting errors that appear
  100. in this page are most likely
  101. to have been introduced during the conversion of the source files to
  102. man page format. To report such errors, see
  103. https://www.kernel.org/doc/man-pages/reporting_bugs.html .