2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
3 .\" permission to reproduce portions of its copyrighted documentation.
4 .\" Original documentation from The Open Group can be obtained online at
5 .\" http://www.opengroup.org/bookstore/.
7 .\" The Institute of Electrical and Electronics Engineers and The Open
8 .\" Group, have given us permission to reprint portions of their
11 .\" In the following statement, the phrase ``this text'' refers to portions
12 .\" of the system documentation.
14 .\" Portions of this text are reprinted and reproduced in electronic form
15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
16 .\" Standard for Information Technology -- Portable Operating System
17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
19 .\" Engineers, Inc and The Open Group. In the event of any discrepancy
20 .\" between these versions and the original IEEE and The Open Group
21 .\" Standard, the original IEEE and The Open Group Standard is the referee
22 .\" document. The original Standard can be obtained online at
23 .\" http://www.opengroup.org/unix/online.html.
25 .\" This notice shall appear on any product containing this material.
27 .\" The contents of this file are subject to the terms of the
28 .\" Common Development and Distribution License (the "License").
29 .\" You may not use this file except in compliance with the License.
31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
32 .\" or http://www.opensolaris.org/os/licensing.
33 .\" See the License for the specific language governing permissions
34 .\" and limitations under the License.
36 .\" When distributing Covered Code, include this CDDL HEADER in each
37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
38 .\" If applicable, add the following below this CDDL HEADER, with the
39 .\" fields enclosed by brackets "[]" replaced with your own identifying
40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
43 .\" Copyright (c) 1992, X/Open Company Limited. All Rights Reserved.
44 .\" Portions Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved
45 .\" Copyright 2014 Garrett D'Amore <garrett@damore.org>
47 .TH WCSCOLL 3C "April 9, 2016"
49 wcscoll, wcscoll_l, wscoll \- wide character string comparison using collating information
55 \fBint\fR \fBwcscoll\fR(\fBconst wchar_t *\fR\fIws1\fR, \fBconst wchar_t *\fR\fIws2\fR);
59 \fBint\fR \fBwcscoll_l\fR(\fBconst wchar_t *\fR\fIws1\fR, \fBconst wchar_t *\fR\fIws2\fR, \fBlocale_t\fR \fIloc\fR);
63 \fBint\fR \fBwscoll\fR(\fBconst wchar_t *\fR\fIws1\fR, \fBconst wchar_t *\fR\fIws2\fR);
67 The \fBwcscoll()\fR, \fBwcscoll_l()\fR, and \fBwscoll()\fR functions compare
69 string pointed to by \fIws1\fR to the wide character string pointed to by
70 \fIws2\fR, both interpreted as appropriate to the \fBLC_COLLATE\fR locale
73 These functions do not change the setting of \fBerrno\fR if successful.
75 An application wanting to check for error situations should set \fBerrno\fR to
76 0 before calling these functions. If \fBerrno\fR is non-zero
77 on return, an error has occurred.
79 The function \fBwcsoll_l()\fR behaves identically to \fBwcsoll\fR(), except
80 instead of operating in the current locale, it operates in the locale
81 specified by \fIloc\fR.
84 Upon successful completion, these functions return an
85 integer greater than, equal to, or less than 0, depending upon whether the wide
86 character string pointed to by \fIws1\fR is greater than, equal to, or less
87 than the wide character string pointed to by \fIws2\fR, when both are
88 interpreted as appropriate to the current locale, or the locale
89 specified by \fIloc\fR. On error,
90 they set \fBerrno\fR, but no return value is reserved to indicate an error.
93 The \fBwcscoll()\fR, \fBwcscoll_l()\fR and \fBwscoll()\fR functions may fail if:
100 The \fIws1\fR or \fIws2\fR arguments contain wide character codes outside the
101 domain of the collating sequence.
105 The \fBwcsxfrm\fR(3C) and \fBwcscmp\fR(3C) functions should be used for sorting
106 large lists, or when performing many comparisons on the same strings.
109 See \fBattributes\fR(5) for descriptions of the following attributes:
114 ATTRIBUTE TYPE ATTRIBUTE VALUE
118 Interface Stability See below.
124 The \fBwcscoll()\fR and \fBwcscoll_l()\fR functions are Standard.
125 The \fBwscoll()\fR function is Committed.
128 \fBnewlocale\fR(3C), \fBsetlocale\fR(3C), \fBuselocale\fR(3C),
129 \fBwcscmp\fR(3C), \fBwcsxfrm\fR(3C), \fBattributes\fR(5),