summaryrefslogtreecommitdiffstats
path: root/upstream/archlinux/man3p/wcscasecmp.3p
blob: 2ed9f9604d4cda04b80736025b1ae4ff2ff45187 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
'\" et
.TH WCSCASECMP "3P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual"
.\"
.SH PROLOG
This manual page is part of the POSIX Programmer's Manual.
The Linux implementation of this interface may differ (consult
the corresponding Linux manual page for details of Linux behavior),
or the interface may not be implemented on Linux.
.\"
.SH NAME
wcscasecmp,
wcscasecmp_l,
wcsncasecmp,
wcsncasecmp_l
\(em case-insensitive wide-character string comparison
.SH SYNOPSIS
.LP
.nf
#include <wchar.h>
.P
int wcscasecmp(const wchar_t *\fIws1\fP, const wchar_t *\fIws2\fP);
int wcscasecmp_l(const wchar_t *\fIws1\fP, const wchar_t *\fIws2\fP,
    locale_t \fIlocale\fP);
int wcsncasecmp(const wchar_t *\fIws1\fP, const wchar_t *\fIws2\fP, size_t \fIn\fP);
int wcsncasecmp_l(const wchar_t *\fIws1\fP, const wchar_t *\fIws2\fP,
    size_t \fIn\fP, locale_t \fIlocale\fP);
.fi
.SH DESCRIPTION
The
\fIwcscasecmp\fR()
and
\fIwcsncasecmp\fR()
functions are the wide-character equivalent of the
\fIstrcasecmp\fR()
and
\fIstrncasecmp\fR()
functions, respectively.
.P
The
\fIwcscasecmp\fR()
and
\fIwcscasecmp_l\fR()
functions shall compare, while ignoring differences in case, the
wide-character string pointed to by
.IR ws1
to the wide-character string pointed to by
.IR ws2 .
.P
The
\fIwcsncasecmp\fR()
and
\fIwcsncasecmp_l\fR()
functions shall compare, while ignoring differences in case, not more
than
.IR n
wide-characters from the wide-character string pointed to by
.IR ws1
to the wide-character string pointed to by
.IR ws2 .
.P
The
\fIwcscasecmp\fR()
and
\fIwcsncasecmp\fR()
functions use the current locale to determine the case of the wide
characters.
.P
The
\fIwcscasecmp_l\fR()
and
\fIwcsncasecmp_l\fR()
functions use the locale represented by
.IR locale
to determine the case of the wide characters.
.P
When the
.IR LC_CTYPE
category of the locale being used is from the POSIX locale, these
functions shall behave as if the wide-character strings had been converted
to lowercase and then a comparison of wide-character codes performed.
Otherwise, the results are unspecified.
.P
The information for
\fIwcscasecmp_l\fR()
and
\fIwcsncasecmp_l\fR()
about the case of the characters comes from the locale represented by
.IR locale .
.P
The behavior is undefined if the
.IR locale
argument to
\fIwcscasecmp_l\fR()
or
\fIwcsncasecmp_l\fR()
is the special locale object LC_GLOBAL_LOCALE or is not a valid locale
object handle.
.SH "RETURN VALUE"
Upon completion, the
\fIwcscasecmp\fR()
and
\fIwcscasecmp_l\fR()
functions shall return an integer greater than, equal to, or less than 0
if the wide-character string pointed to by
.IR ws1
is, ignoring case, greater than, equal to, or less than the
wide-character string pointed to by
.IR ws2 ,
respectively.
.P
Upon completion, the
\fIwcsncasecmp\fR()
and
\fIwcsncasecmp_l\fR()
functions shall return an integer greater than, equal to, or less than 0
if the possibly null wide-character terminated string pointed to by
.IR ws1
is, ignoring case, greater than, equal to, or less than the possibly
null wide-character terminated string pointed to by
.IR ws2 ,
respectively.
.P
No return values are reserved to indicate an error.
.SH ERRORS
No errors are defined.
.LP
.IR "The following sections are informative."
.SH EXAMPLES
None.
.SH "APPLICATION USAGE"
None.
.SH RATIONALE
None.
.SH "FUTURE DIRECTIONS"
None.
.SH "SEE ALSO"
.IR "\fIstrcasecmp\fR\^(\|)",
.IR "\fIwcscmp\fR\^(\|)",
.IR "\fIwcsncmp\fR\^(\|)"
.P
The Base Definitions volume of POSIX.1\(hy2017,
.IR "\fB<wchar.h>\fP"
.\"
.SH COPYRIGHT
Portions of this text are reprinted and reproduced in electronic form
from IEEE Std 1003.1-2017, Standard for Information Technology
-- Portable Operating System Interface (POSIX), The Open Group Base
Specifications Issue 7, 2018 Edition,
Copyright (C) 2018 by the Institute of
Electrical and Electronics Engineers, Inc and The Open Group.
In the event of any discrepancy between this version and the original IEEE and
The Open Group Standard, the original IEEE and The Open Group Standard
is the referee document. The original Standard can be obtained online at
http://www.opengroup.org/unix/online.html .
.PP
Any typographical or formatting errors that appear
in this page are most likely
to have been introduced during the conversion of the source files to
man page format. To report such errors, see
https://www.kernel.org/doc/man-pages/reporting_bugs.html .