Print this page
11586 NAME field in man pages should match what's installed
| Split |
Close |
| Expand all |
| Collapse all |
--- old/usr/src/man/man3c/wcscoll.3c
+++ new/usr/src/man/man3c/wcscoll.3c
1 1 .\"
2 2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
3 3 .\" permission to reproduce portions of its copyrighted documentation.
4 4 .\" Original documentation from The Open Group can be obtained online at
5 5 .\" http://www.opengroup.org/bookstore/.
6 6 .\"
7 7 .\" The Institute of Electrical and Electronics Engineers and The Open
8 8 .\" Group, have given us permission to reprint portions of their
9 9 .\" documentation.
10 10 .\"
11 11 .\" In the following statement, the phrase ``this text'' refers to portions
12 12 .\" of the system documentation.
13 13 .\"
14 14 .\" Portions of this text are reprinted and reproduced in electronic form
15 15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
16 16 .\" Standard for Information Technology -- Portable Operating System
17 17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
18 18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
19 19 .\" Engineers, Inc and The Open Group. In the event of any discrepancy
20 20 .\" between these versions and the original IEEE and The Open Group
21 21 .\" Standard, the original IEEE and The Open Group Standard is the referee
22 22 .\" document. The original Standard can be obtained online at
23 23 .\" http://www.opengroup.org/unix/online.html.
24 24 .\"
25 25 .\" This notice shall appear on any product containing this material.
26 26 .\"
27 27 .\" The contents of this file are subject to the terms of the
28 28 .\" Common Development and Distribution License (the "License").
29 29 .\" You may not use this file except in compliance with the License.
30 30 .\"
31 31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
32 32 .\" or http://www.opensolaris.org/os/licensing.
33 33 .\" See the License for the specific language governing permissions
34 34 .\" and limitations under the License.
35 35 .\"
36 36 .\" When distributing Covered Code, include this CDDL HEADER in each
|
↓ open down ↓ |
36 lines elided |
↑ open up ↑ |
37 37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
38 38 .\" If applicable, add the following below this CDDL HEADER, with the
39 39 .\" fields enclosed by brackets "[]" replaced with your own identifying
40 40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
41 41 .\"
42 42 .\"
43 43 .\" Copyright (c) 1992, X/Open Company Limited. All Rights Reserved.
44 44 .\" Portions Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved
45 45 .\" Copyright 2014 Garrett D'Amore <garrett@damore.org>
46 46 .\"
47 -.TH WCSCOLL 3C "April 9, 2016"
47 +.TH WCSCOLL 3C "Aug 20, 2019"
48 48 .SH NAME
49 -wcscoll, wcscoll_l wscoll \- wide character string comparison using collating information
49 +wcscoll, wcscoll_l, wscoll \- wide character string comparison using collating information
50 50 .SH SYNOPSIS
51 -.LP
52 51 .nf
53 52 #include <wchar.h>
54 53
55 54 \fBint\fR \fBwcscoll\fR(\fBconst wchar_t *\fR\fIws1\fR, \fBconst wchar_t *\fR\fIws2\fR);
56 55 .fi
57 56 .LP
58 57 .nf
59 58 \fBint\fR \fBwcscoll_l\fR(\fBconst wchar_t *\fR\fIws1\fR, \fBconst wchar_t *\fR\fIws2\fR, \fBlocale_t\fR \fIloc\fR);
60 59 .fi
61 60 .LP
62 61 .nf
63 62 \fBint\fR \fBwscoll\fR(\fBconst wchar_t *\fR\fIws1\fR, \fBconst wchar_t *\fR\fIws2\fR);
64 63 .fi
65 64 .SH DESCRIPTION
66 -.LP
67 65 The \fBwcscoll()\fR, \fBwcscoll_l()\fR, and \fBwscoll()\fR functions compare
68 66 the wide character
69 67 string pointed to by \fIws1\fR to the wide character string pointed to by
70 68 \fIws2\fR, both interpreted as appropriate to the \fBLC_COLLATE\fR locale
71 69 category.
72 70 .LP
73 71 These functions do not change the setting of \fBerrno\fR if successful.
74 72 .LP
75 73 An application wanting to check for error situations should set \fBerrno\fR to
76 74 0 before calling these functions. If \fBerrno\fR is non-zero
77 75 on return, an error has occurred.
78 76 .LP
79 77 The function \fBwcsoll_l()\fR behaves identically to \fBwcsoll\fR(), except
80 78 instead of operating in the current locale, it operates in the locale
81 79 specified by \fIloc\fR.
82 80 .SH RETURN VALUES
83 -.LP
84 81 Upon successful completion, these functions return an
85 82 integer greater than, equal to, or less than 0, depending upon whether the wide
86 83 character string pointed to by \fIws1\fR is greater than, equal to, or less
87 84 than the wide character string pointed to by \fIws2\fR, when both are
88 85 interpreted as appropriate to the current locale, or the locale
89 86 specified by \fIloc\fR. On error,
90 87 they set \fBerrno\fR, but no return value is reserved to indicate an error.
91 88 .SH ERRORS
92 -.LP
93 89 The \fBwcscoll()\fR, \fBwcscoll_l()\fR and \fBwscoll()\fR functions may fail if:
94 90 .sp
95 91 .ne 2
96 92 .na
97 -\fB\fBEINVAL\fR\fR
93 +\fBEINVAL\fR
98 94 .ad
99 95 .RS 10n
100 96 The \fIws1\fR or \fIws2\fR arguments contain wide character codes outside the
101 97 domain of the collating sequence.
102 98 .RE
103 99 .SH USAGE
104 -.LP
105 100 The \fBwcsxfrm\fR(3C) and \fBwcscmp\fR(3C) functions should be used for sorting
106 101 large lists, or when performing many comparisons on the same strings.
107 102 .SH ATTRIBUTES
108 -.LP
109 103 See \fBattributes\fR(5) for descriptions of the following attributes:
110 104 .TS
111 105 box;
112 106 c | c
113 107 l | l .
114 108 ATTRIBUTE TYPE ATTRIBUTE VALUE
115 109 _
116 110 CSI Enabled
117 111 _
118 112 Interface Stability See below.
119 113 _
120 114 MT-Level MT-Safe
121 115 .TE
122 116
123 117 .LP
124 118 The \fBwcscoll()\fR and \fBwcscoll_l()\fR functions are Standard.
125 119 The \fBwscoll()\fR function is Committed.
126 120 .SH SEE ALSO
127 -.LP
128 121 \fBnewlocale\fR(3C), \fBsetlocale\fR(3C), \fBuselocale\fR(3C),
129 122 \fBwcscmp\fR(3C), \fBwcsxfrm\fR(3C), \fBattributes\fR(5),
130 123 \fBstandards\fR(5)
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX