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

wctrans.3p (3805B)

    

  1. '\" et
  2. .TH WCTRANS "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. wctrans,
  12. wctrans_l
  13. \(em define character mapping
  14. .SH SYNOPSIS
  15. .LP
  16. .nf
  17. #include <wctype.h>
  18. .P
  19. wctrans_t wctrans(const char *\fIcharclass\fP);
  20. wctrans_t wctrans_l(const char *\fIcharclass\fP, locale_t \fIlocale\fP);
  21. .fi
  22. .SH DESCRIPTION
  23. For
  24. \fIwctrans\fR():
  25. The functionality described on this reference page is aligned with the
  26. ISO\ C standard. Any conflict between the requirements described here and the
  27. ISO\ C standard is unintentional. This volume of POSIX.1\(hy2017 defers to the ISO\ C standard.
  28. .P
  29. The
  30. \fIwctrans\fR()
  31. and
  32. \fIwctrans_l\fR()
  33. functions are defined for valid character mapping names identified
  34. in the current locale. The
  35. .IR charclass
  36. is a string identifying a generic character mapping name for which
  37. codeset-specific information is required. The following character
  38. mapping names are defined in all locales:
  39. .BR tolower
  40. and
  41. .BR toupper .
  42. .P
  43. These functions shall return a value of type
  44. .BR wctrans_t ,
  45. which can be used as the second argument to subsequent calls of
  46. \fItowctrans\fR()
  47. and
  48. \fItowctrans_l\fR().
  49. .P
  50. The
  51. \fIwctrans\fR()
  52. and
  53. \fIwctrans_l\fR()
  54. functions shall determine values of
  55. .BR wctrans_t
  56. according to the rules of the coded character set defined by character
  57. mapping information in the current locale
  58. or in the locale represented by
  59. .IR locale ,
  60. respectively (category
  61. .IR LC_CTYPE ).
  62. .P
  63. The values returned by
  64. \fIwctrans\fR()
  65. shall be valid until a call to
  66. \fIsetlocale\fR()
  67. that modifies the category
  68. .IR LC_CTYPE .
  69. .P
  70. The values returned by
  71. \fIwctrans_l\fR()
  72. shall be valid only in calls to
  73. \fItowctrans_l\fR()
  74. with a locale represented by
  75. .IR locale
  76. with the same
  77. .IR LC_CTYPE
  78. category value.
  79. .P
  80. The behavior is undefined if the
  81. .IR locale
  82. argument to
  83. \fIwctrans_l\fR()
  84. is the special locale object LC_GLOBAL_LOCALE or is not a valid locale
  85. object handle.
  86. .SH "RETURN VALUE"
  87. The
  88. \fIwctrans\fR()
  89. and
  90. \fIwctrans_l\fR()
  91. functions shall return 0 and may set
  92. .IR errno
  93. to indicate the error if the given character mapping name is not valid
  94. for the current locale (category
  95. .IR LC_CTYPE );
  96. otherwise, they shall return a non-zero object of type
  97. .BR wctrans_t
  98. that can be used in calls to
  99. \fItowctrans\fR()
  100. and
  101. \fItowctrans_l\fR().
  102. .SH ERRORS
  103. These functions may fail if:
  104. .TP
  105. .BR EINVAL
  106. The character mapping name pointed to by
  107. .IR charclass
  108. is not valid in the current locale.
  109. .LP
  110. .IR "The following sections are informative."
  111. .SH EXAMPLES
  112. None.
  113. .SH "APPLICATION USAGE"
  114. None.
  115. .SH RATIONALE
  116. None.
  117. .SH "FUTURE DIRECTIONS"
  118. None.
  119. .SH "SEE ALSO"
  120. .IR "\fItowctrans\fR\^(\|)"
  121. .P
  122. The Base Definitions volume of POSIX.1\(hy2017,
  123. .IR "\fB<wctype.h>\fP"
  124. .\"
  125. .SH COPYRIGHT
  126. Portions of this text are reprinted and reproduced in electronic form
  127. from IEEE Std 1003.1-2017, Standard for Information Technology
  128. -- Portable Operating System Interface (POSIX), The Open Group Base
  129. Specifications Issue 7, 2018 Edition,
  130. Copyright (C) 2018 by the Institute of
  131. Electrical and Electronics Engineers, Inc and The Open Group.
  132. In the event of any discrepancy between this version and the original IEEE and
  133. The Open Group Standard, the original IEEE and The Open Group Standard
  134. is the referee document. The original Standard can be obtained online at
  135. http://www.opengroup.org/unix/online.html .
  136. .PP
  137. Any typographical or formatting errors that appear
  138. in this page are most likely
  139. to have been introduced during the conversion of the source files to
  140. man page format. To report such errors, see
  141. https://www.kernel.org/doc/man-pages/reporting_bugs.html .