1WCSCOLL(3P) POSIX Programmer's Manual WCSCOLL(3P)
2
6 This manual page is part of the POSIX Programmer's Manual. The Linux
7 implementation of this interface may differ (consult the corresponding
8 Linux manual page for details of Linux behavior), or the interface may
9 not be implemented on Linux.
10
13 wcscoll, wcscoll_l — wide-character string comparison using collating
14 information
15
17 #include <wchar.h>
18 int wcscoll(const wchar_t *ws1, const wchar_t *ws2);
20 int wcscoll_l(const wchar_t *ws1, const wchar_t *ws2,
21 locale_t locale);
22
24 For wcscoll(): The functionality described on this reference page is
25 aligned with the ISO C standard. Any conflict between the requirements
26 described here and the ISO C standard is unintentional. This volume of
27 POSIX.1‐2008 defers to the ISO C standard.
28 The wcscoll() and wcscoll_l() functions shall compare the wide-charac‐
30 ter string pointed to by ws1 to the wide-character string pointed to by
31 ws2, both interpreted as appropriate to the LC_COLLATE category of the
32 current locale, or the locale represented by locale, respectively.
33 The wcscoll() and wcscoll_l() functions shall not change the setting of
35 errno if successful.
36 An application wishing to check for error situations should set errno
38 to 0 before calling wcscoll() or wcscoll_l(). If errno is non-zero on
39 return, an error has occurred.
40 The behavior is undefined if the locale argument to wcscoll_l() is the
42 special locale object LC_GLOBAL_LOCALE or is not a valid locale object
43 handle.
44
46 Upon successful completion, wcscoll() and wcscoll_l() shall return an
47 integer greater than, equal to, or less than 0, according to whether
48 the wide-character string pointed to by ws1 is greater than, equal to,
49 or less than the wide-character string pointed to by ws2, when both are
50 interpreted as appropriate to the current locale, or to the locale rep‐
51 resented by locale, respectively. On error, wcscoll() and wcscoll_l()
52 shall set errno, but no return value is reserved to indicate an error.
53
55 These functions may fail if:
56 EINVAL The ws1 or ws2 arguments contain wide-character codes outside
58 the domain of the collating sequence.
59 The following sections are informative.
61
63 None.
64
66 The wcsxfrm() and wcscmp() functions should be used for sorting large
67 lists.
68
70 None.
71
73 None.
74
76 wcscmp(), wcsxfrm()
77 The Base Definitions volume of POSIX.1‐2008, <wchar.h>
79
81 Portions of this text are reprinted and reproduced in electronic form
82 from IEEE Std 1003.1, 2013 Edition, Standard for Information Technology
83 -- Portable Operating System Interface (POSIX), The Open Group Base
84 Specifications Issue 7, Copyright (C) 2013 by the Institute of Electri‐
85 cal and Electronics Engineers, Inc and The Open Group. (This is
86 POSIX.1-2008 with the 2013 Technical Corrigendum 1 applied.) In the
87 event of any discrepancy between this version and the original IEEE and
88 The Open Group Standard, the original IEEE and The Open Group Standard
89 is the referee document. The original Standard can be obtained online
90 at http://www.unix.org/online.html .
91 Any typographical or formatting errors that appear in this page are
93 most likely to have been introduced during the conversion of the source
94 files to man page format. To report such errors, see https://www.ker‐
95 nel.org/doc/man-pages/reporting_bugs.html .
96IEEE/The Open Group 2013 WCSCOLL(3P)