.\"	$OpenBSD: wcscasecmp.3,v 1.5 2017/09/05 03:16:14 schwarze Exp $
.\"
.\" Copyright (c) 1990, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\" Copyright (c) 2017 Ingo Schwarze <schwarze@openbsd.org>
.\"
.\" This code is derived from software contributed to Berkeley by
.\" Chris Torek.
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)strcasecmp.3	8.1 (Berkeley) 6/9/93
.\"
.Dd $Mdocdate: September 5 2017 $
.Dt WCSCASECMP 3
.Os
.Sh NAME
.Nm wcscasecmp ,
.Nm wcscasecmp_l ,
.Nm wcsncasecmp ,
.Nm wcsncasecmp_l
.Nd compare wide strings, ignoring case
.Sh SYNOPSIS
.In wchar.h
.Ft int
.Fo wcscasecmp
.Fa "const wchar_t *s1"
.Fa "const wchar_t *s2"
.Fc
.Ft int
.Fo wcscasecmp_l
.Fa "const wchar_t *s1"
.Fa "const wchar_t *s2"
.Fa "locale_t locale"
.Fc
.Ft int
.Fo wcsncasecmp
.Fa "const wchar_t *s1"
.Fa "const wchar_t *s2"
.Fa "size_t len"
.Fc
.Ft int
.Fo wcsncasecmp_l
.Fa "const wchar_t *s1"
.Fa "const wchar_t *s2"
.Fa "size_t len"
.Fa "locale_t locale"
.Fc
.Sh DESCRIPTION
These functions compare the wide strings
.Fa s1
and
.Fa s2
and return an integer greater than, equal to, or less than 0,
according to whether
.Fa s1
is lexicographically greater than, equal to, or less than
.Fa s2
after translation of each corresponding wide character to lower case.
The wide strings themselves are not modified.
.Pp
For the translation to lower case,
.Fn wcscasecmp
and
.Fn wcsncasecmp
use the thread-specific locale as defined with
.Xr uselocale 3 ,
falling back to the global locale defined with
.Xr setlocale 3 .
.Fn wcscasecmp_l
and
.Fn wcsncasecmp_l
use the
.Fa locale
argument instead.
.Pp
.Fn wcsncasecmp
and
.Fn wcsncasecmp_l
compare at most
.Fa len
wide characters.
.Sh SEE ALSO
.Xr newlocale 3 ,
.Xr setlocale 3 ,
.Xr strcasecmp 3 ,
.Xr wcscmp 3 ,
.Xr wmemcmp 3
.Sh STANDARDS
These functions conform to
.St -p1003.1-2008 .
.Sh HISTORY
The
.Fn wcscasecmp
and
.Fn wcsncasecmp
functions have been available since
.Ox 5.0 ,
and
.Fn wcscasecmp_l
and
.Fn wcsncasecmp_l
since
.Ox 6.2 .
.Sh AUTHORS
The
.Ox
versions of
.Fn wcscasecmp
and
.Fn wcsncasecmp
were implemented by
.An Marc Espie Aq Mt espie@openbsd.org .