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.
30 .\"
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.
35 .\"
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]
41 .\"
42 .\"
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>
46 .\"
47 .TH WCSCOLL 3C "April 9, 2016"
48 .SH NAME
49 wcscoll, wcscoll_l wscoll \- wide character string comparison using collating information
50 .SH SYNOPSIS
51 .LP
52 .nf
53 #include <wchar.h>
54
55 \fBint\fR \fBwcscoll\fR(\fBconst wchar_t *\fR\fIws1\fR, \fBconst wchar_t *\fR\fIws2\fR);
56 .fi
57 .LP
58 .nf
59 \fBint\fR \fBwcscoll_l\fR(\fBconst wchar_t *\fR\fIws1\fR, \fBconst wchar_t *\fR\fIws2\fR, \fBlocale_t\fR \fIloc\fR);
60 .fi
61 .LP
62 .nf
63 \fBint\fR \fBwscoll\fR(\fBconst wchar_t *\fR\fIws1\fR, \fBconst wchar_t *\fR\fIws2\fR);
64 .fi
65 .SH DESCRIPTION
66 .LP
67 The \fBwcscoll()\fR, \fBwcscoll_l()\fR, and \fBwscoll()\fR functions compare
68 the wide character
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
71 category.
72 .LP
73 These functions do not change the setting of \fBerrno\fR if successful.
74 .LP
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.
78 .LP
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.
82 .SH RETURN VALUES
83 .LP
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.
91 .SH ERRORS
92 .LP
93 The \fBwcscoll()\fR, \fBwcscoll_l()\fR and \fBwscoll()\fR functions may fail if:
94 .sp
95 .ne 2
96 .na
97 \fB\fBEINVAL\fR\fR
98 .ad
99 .RS 10n
100 The \fIws1\fR or \fIws2\fR arguments contain wide character codes outside the
101 domain of the collating sequence.
102 .RE
103 .SH USAGE
104 .LP
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.
107 .SH ATTRIBUTES
108 .LP
109 See \fBattributes\fR(5) for descriptions of the following attributes:
110 .TS
111 box;
112 c | c
113 l | l .
114 ATTRIBUTE TYPE ATTRIBUTE VALUE
115 _
116 CSI Enabled
117 _
118 Interface Stability See below.
119 _
120 MT-Level MT-Safe
121 .TE
122
123 .LP
124 The \fBwcscoll()\fR and \fBwcscoll_l()\fR functions are Standard.
125 The \fBwscoll()\fR function is Committed.
126 .SH SEE ALSO
127 .LP
128 \fBnewlocale\fR(3C), \fBsetlocale\fR(3C), \fBuselocale\fR(3C),
129 \fBwcscmp\fR(3C), \fBwcsxfrm\fR(3C), \fBattributes\fR(5),
130 \fBstandards\fR(5)
|
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.
30 .\"
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.
35 .\"
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]
41 .\"
42 .\"
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>
46 .\"
47 .TH WCSCOLL 3C "Aug 20, 2019"
48 .SH NAME
49 wcscoll, wcscoll_l, wscoll \- wide character string comparison using collating information
50 .SH SYNOPSIS
51 .nf
52 #include <wchar.h>
53
54 \fBint\fR \fBwcscoll\fR(\fBconst wchar_t *\fR\fIws1\fR, \fBconst wchar_t *\fR\fIws2\fR);
55 .fi
56 .LP
57 .nf
58 \fBint\fR \fBwcscoll_l\fR(\fBconst wchar_t *\fR\fIws1\fR, \fBconst wchar_t *\fR\fIws2\fR, \fBlocale_t\fR \fIloc\fR);
59 .fi
60 .LP
61 .nf
62 \fBint\fR \fBwscoll\fR(\fBconst wchar_t *\fR\fIws1\fR, \fBconst wchar_t *\fR\fIws2\fR);
63 .fi
64 .SH DESCRIPTION
65 The \fBwcscoll()\fR, \fBwcscoll_l()\fR, and \fBwscoll()\fR functions compare
66 the wide character
67 string pointed to by \fIws1\fR to the wide character string pointed to by
68 \fIws2\fR, both interpreted as appropriate to the \fBLC_COLLATE\fR locale
69 category.
70 .LP
71 These functions do not change the setting of \fBerrno\fR if successful.
72 .LP
73 An application wanting to check for error situations should set \fBerrno\fR to
74 0 before calling these functions. If \fBerrno\fR is non-zero
75 on return, an error has occurred.
76 .LP
77 The function \fBwcsoll_l()\fR behaves identically to \fBwcsoll\fR(), except
78 instead of operating in the current locale, it operates in the locale
79 specified by \fIloc\fR.
80 .SH RETURN VALUES
81 Upon successful completion, these functions return an
82 integer greater than, equal to, or less than 0, depending upon whether the wide
83 character string pointed to by \fIws1\fR is greater than, equal to, or less
84 than the wide character string pointed to by \fIws2\fR, when both are
85 interpreted as appropriate to the current locale, or the locale
86 specified by \fIloc\fR. On error,
87 they set \fBerrno\fR, but no return value is reserved to indicate an error.
88 .SH ERRORS
89 The \fBwcscoll()\fR, \fBwcscoll_l()\fR and \fBwscoll()\fR functions may fail if:
90 .sp
91 .ne 2
92 .na
93 \fBEINVAL\fR
94 .ad
95 .RS 10n
96 The \fIws1\fR or \fIws2\fR arguments contain wide character codes outside the
97 domain of the collating sequence.
98 .RE
99 .SH USAGE
100 The \fBwcsxfrm\fR(3C) and \fBwcscmp\fR(3C) functions should be used for sorting
101 large lists, or when performing many comparisons on the same strings.
102 .SH ATTRIBUTES
103 See \fBattributes\fR(5) for descriptions of the following attributes:
104 .TS
105 box;
106 c | c
107 l | l .
108 ATTRIBUTE TYPE ATTRIBUTE VALUE
109 _
110 CSI Enabled
111 _
112 Interface Stability See below.
113 _
114 MT-Level MT-Safe
115 .TE
116
117 .LP
118 The \fBwcscoll()\fR and \fBwcscoll_l()\fR functions are Standard.
119 The \fBwscoll()\fR function is Committed.
120 .SH SEE ALSO
121 \fBnewlocale\fR(3C), \fBsetlocale\fR(3C), \fBuselocale\fR(3C),
122 \fBwcscmp\fR(3C), \fBwcsxfrm\fR(3C), \fBattributes\fR(5),
123 \fBstandards\fR(5)
|