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

wcscoll.3p (3672B)

    

  1. '\" et
  2. .TH WCSCOLL "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. wcscoll,
  12. wcscoll_l
  13. \(em wide-character string comparison using collating information
  14. .SH SYNOPSIS
  15. .LP
  16. .nf
  17. #include <wchar.h>
  18. .P
  19. int wcscoll(const wchar_t *\fIws1\fP, const wchar_t *\fIws2\fP);
  20. int wcscoll_l(const wchar_t *\fIws1\fP, const wchar_t *\fIws2\fP,
  21.     locale_t \fIlocale\fP);
  22. .fi
  23. .SH DESCRIPTION
  24. For
  25. \fIwcscoll\fR():
  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. The
  31. \fIwcscoll\fR()
  32. and
  33. \fIwcscoll_l\fR()
  34. functions shall compare the wide-character string pointed to by
  35. .IR ws1
  36. to the wide-character string pointed to by
  37. .IR ws2 ,
  38. both interpreted as appropriate to the
  39. .IR LC_COLLATE
  40. category of the current locale,
  41. or the locale represented by
  42. .IR locale ,
  43. respectively.
  44. .P
  45. The
  46. \fIwcscoll\fR()
  47. and
  48. \fIwcscoll_l\fR()
  49. functions shall not change the setting of
  50. .IR errno
  51. if successful.
  52. .P
  53. An application wishing to check for error situations should set
  54. .IR errno
  55. to 0 before calling
  56. \fIwcscoll\fR()
  57. or
  58. \fIwcscoll_l\fR().
  59. If
  60. .IR errno
  61. is non-zero on return, an error has occurred.
  62. .P
  63. The behavior is undefined if the
  64. .IR locale
  65. argument to
  66. \fIwcscoll_l\fR()
  67. is the special locale object LC_GLOBAL_LOCALE or is not a valid locale
  68. object handle.
  69. .SH "RETURN VALUE"
  70. Upon successful completion,
  71. \fIwcscoll\fR()
  72. and
  73. \fIwcscoll_l\fR()
  74. shall return an integer greater than, equal to, or less than 0,
  75. according to whether the wide-character string pointed to by
  76. .IR ws1
  77. is greater than, equal to, or less than the wide-character string
  78. pointed to by
  79. .IR ws2 ,
  80. when both are interpreted as appropriate to the current locale,
  81. or to the locale represented by
  82. .IR locale ,
  83. respectively. On error,
  84. \fIwcscoll\fR()
  85. and
  86. \fIwcscoll_l\fR()
  87. shall set
  88. .IR errno ,
  89. but no return value is reserved to indicate an error.
  90. .SH ERRORS
  91. These functions may fail if:
  92. .TP
  93. .BR EINVAL
  94. The
  95. .IR ws1
  96. or
  97. .IR ws2
  98. arguments contain wide-character codes outside the domain of the
  99. collating sequence.
  100. .LP
  101. .IR "The following sections are informative."
  102. .SH EXAMPLES
  103. None.
  104. .SH "APPLICATION USAGE"
  105. The
  106. \fIwcsxfrm\fR()
  107. and
  108. \fIwcscmp\fR()
  109. functions should be used for sorting large lists.
  110. .SH RATIONALE
  111. None.
  112. .SH "FUTURE DIRECTIONS"
  113. None.
  114. .SH "SEE ALSO"
  115. .IR "\fIwcscmp\fR\^(\|)",
  116. .IR "\fIwcsxfrm\fR\^(\|)"
  117. .P
  118. The Base Definitions volume of POSIX.1\(hy2017,
  119. .IR "\fB<wchar.h>\fP"
  120. .\"
  121. .SH COPYRIGHT
  122. Portions of this text are reprinted and reproduced in electronic form
  123. from IEEE Std 1003.1-2017, Standard for Information Technology
  124. -- Portable Operating System Interface (POSIX), The Open Group Base
  125. Specifications Issue 7, 2018 Edition,
  126. Copyright (C) 2018 by the Institute of
  127. Electrical and Electronics Engineers, Inc and The Open Group.
  128. In the event of any discrepancy between this version and the original IEEE and
  129. The Open Group Standard, the original IEEE and The Open Group Standard
  130. is the referee document. The original Standard can be obtained online at
  131. http://www.opengroup.org/unix/online.html .
  132. .PP
  133. Any typographical or formatting errors that appear
  134. in this page are most likely
  135. to have been introduced during the conversion of the source files to
  136. man page format. To report such errors, see
  137. https://www.kernel.org/doc/man-pages/reporting_bugs.html .