xref: /netbsd-src/lib/libc/string/wcscasecmp.3 (revision 263b36c655d69e273572c9ca955fbcf01fea1dda)
1.\"	$NetBSD: wcscasecmp.3,v 1.6 2016/07/14 16:09:56 abhinav Exp $
2.\"
3.\" Copyright (c) 1990, 1991, 1993
4.\"	The Regents of the University of California.  All rights reserved.
5.\"
6.\" This code is derived from software contributed to Berkeley by
7.\" Chris Torek.
8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions
10.\" are met:
11.\" 1. Redistributions of source code must retain the above copyright
12.\"    notice, this list of conditions and the following disclaimer.
13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\"    notice, this list of conditions and the following disclaimer in the
15.\"    documentation and/or other materials provided with the distribution.
16.\" 3. Neither the name of the University nor the names of its contributors
17.\"    may be used to endorse or promote products derived from this software
18.\"    without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.\"     from: @(#)wcscasecmp.3	8.1 (Berkeley) 6/9/93
33.\"
34.Dd July 13, 2016
35.Dt WCSCASECMP 3
36.Os
37.Sh NAME
38.Nm wcscasecmp ,
39.Nm wcsncasecmp
40.Nd compare wide-character strings, ignoring case
41.Sh LIBRARY
42.Lb libc
43.Sh SYNOPSIS
44.In wchar.h
45.Ft int
46.Fn wcscasecmp "const wchar_t *s1" "const wchar_t *s2"
47.Ft int
48.Fn wcsncasecmp "const wchar_t *s1" "const wchar_t *s2" "size_t len"
49.Sh DESCRIPTION
50The
51.Fn wcscasecmp
52and
53.Fn wcsncasecmp
54functions
55compare the nul-terminated strings
56.Fa s1
57and
58.Fa s2
59and return an integer greater than, equal to, or less than 0,
60according to whether
61.Fa s1
62is lexicographically greater than, equal to, or less than
63.Fa s2
64after translation of each corresponding character to lower-case.
65The strings themselves are not modified.
66.Pp
67The
68.Fn wcsncasecmp
69function compares at most
70.Fa len
71characters.
72.Sh SEE ALSO
73.Xr wcscmp 3
74.Sh STANDARDS
75The
76.Fn wcscasecmp
77and
78.Fn wcsncasecmp
79functions conform to
80.St -p1003.1-2008 .
81.Sh HISTORY
82The
83.Fn wcscasecmp
84and
85.Fn wcsncasecmp
86functions first appeared in
87.Nx 4.0 .
88.Sh NOTES
89If
90.Fa len
91is 0,
92.Fn wcsncasecmp
93always returns 0.
94