[thirdparty/man-pages.git] / man3 / wcscasecmp.3

.\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
.\"
.\" This is free documentation; you can redistribute it and/or
.\" modify it under the terms of the GNU General Public License as
.\" published by the Free Software Foundation; either version 2 of
.\" the License, or (at your option) any later version.
.\"
.\" References consulted:
.\"   GNU glibc-2 source code and manual
.\"   Dinkumware C library reference http://www.dinkumware.com/
.\"   OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html
.\"
.TH WCSCASECMP 3 2010-09-15 "GNU" "Linux Programmer's Manual"
.SH NAME
wcscasecmp \- compare two wide-character strings, ignoring case
.SH SYNOPSIS
.nf
.B #include <wchar.h>
.sp
.BI "int wcscasecmp(const wchar_t *" s1 ", const wchar_t *" s2 );
.fi
.sp
.in -4n
Feature Test Macro Requirements for glibc (see
.BR feature_test_macros (7)):
.in
.sp
.BR wcscasecmp ():
.PD 0
.ad l
.RS 4
.TP 4
Since glibc 2.10:
_XOPEN_SOURCE\ >=\ 700 || _POSIX_C_SOURCE\ >=\ 200809L
.TP
Before glibc 2.10:
_GNU_SOURCE
.RE
.ad
.PD
.SH DESCRIPTION
The
.BR wcscasecmp ()
function is the wide-character equivalent of the
.BR strcasecmp (3)
function.
It compares the wide-character string pointed to
by \fIs1\fP and the wide-character string pointed to by \fIs2\fP, ignoring
case differences
.RB ( towupper (3),
.BR towlower (3)).
.SH RETURN VALUE
The
.BR wcscasecmp ()
function returns zero if the wide-character strings at
\fIs1\fP and \fIs2\fP are equal except for case distinctions.
It returns a
positive integer if \fIs1\fP is greater than \fIs2\fP, ignoring case.
It
returns a negative integer if \fIs1\fP is smaller
than \fIs2\fP, ignoring case.
.SH VERSIONS
The
.BR wcscasecmp ()
function is provided in glibc since version 2.1.
.SH CONFORMING TO
POSIX.1-2008.
This function is not specified in POSIX.1-2001,
and is not widely available on other systems.
.SH NOTES
The behavior of
.BR wcscasecmp ()
depends on the
.B LC_CTYPE
category of the
current locale.
.SH SEE ALSO
.BR strcasecmp (3),
.BR wcscmp (3)
Commit	Line	Data
fea681da MK	1	.\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
	2	.\"
	3	.\" This is free documentation; you can redistribute it and/or
	4	.\" modify it under the terms of the GNU General Public License as
	5	.\" published by the Free Software Foundation; either version 2 of
	6	.\" the License, or (at your option) any later version.
	7	.\"
	8	.\" References consulted:
	9	.\" GNU glibc-2 source code and manual
	10	.\" Dinkumware C library reference http://www.dinkumware.com/
008f1ecc	11	.\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html
fea681da	12	.\"
df362fbf	13	.TH WCSCASECMP 3 2010-09-15 "GNU" "Linux Programmer's Manual"
fea681da MK	14	.SH NAME
	15	wcscasecmp \- compare two wide-character strings, ignoring case
	16	.SH SYNOPSIS
	17	.nf
	18	.B #include <wchar.h>
	19	.sp
	20	.BI "int wcscasecmp(const wchar_t " s1 ", const wchar_t " s2 );
	21	.fi
df362fbf MK	22	.sp
	23	.in -4n
	24	Feature Test Macro Requirements for glibc (see
	25	.BR feature_test_macros (7)):
	26	.in
	27	.sp
	28	.BR wcscasecmp ():
ea91c3fd MK	29	.PD 0
	30	.ad l
	31	.RS 4
	32	.TP 4
	33	Since glibc 2.10:
	34	_XOPEN_SOURCE\ >=\ 700 \|\| _POSIX_C_SOURCE\ >=\ 200809L
	35	.TP
df362fbf MK	36	Before glibc 2.10:
df362fbf MK	37	_GNU_SOURCE
ea91c3fd MK	38	.RE
	39	.ad
	40	.PD
fea681da	41	.SH DESCRIPTION
60a90ecd MK	42	The
	43	.BR wcscasecmp ()
	44	function is the wide-character equivalent of the
	45	.BR strcasecmp (3)
	46	function.
c13182ef	47	It compares the wide-character string pointed to
fea681da	48	by \fIs1\fP and the wide-character string pointed to by \fIs2\fP, ignoring
60a90ecd MK	49	case differences
	50	.RB ( towupper (3),
	51	.BR towlower (3)).
47297adb	52	.SH RETURN VALUE
60a90ecd MK	53	The
	54	.BR wcscasecmp ()
	55	function returns zero if the wide-character strings at
c13182ef MK	56	\fIs1\fP and \fIs2\fP are equal except for case distinctions.
	57	It returns a
	58	positive integer if \fIs1\fP is greater than \fIs2\fP, ignoring case.
	59	It
	60	returns a negative integer if \fIs1\fP is smaller
	61	than \fIs2\fP, ignoring case.
51d42330 MK	62	.SH VERSIONS
	63	The
	64	.BR wcscasecmp ()
	65	function is provided in glibc since version 2.1.
47297adb	66	.SH CONFORMING TO
21696186 MK	67	POSIX.1-2008.
	68	This function is not specified in POSIX.1-2001,
	69	and is not widely available on other systems.
fea681da	70	.SH NOTES
d9bfdb9c	71	The behavior of
60a90ecd	72	.BR wcscasecmp ()
1274071a MK	73	depends on the
	74	.B LC_CTYPE
	75	category of the
fea681da	76	current locale.
47297adb	77	.SH SEE ALSO
e37e3282 MK	78	.BR strcasecmp (3),
e37e3282 MK	79	.BR wcscmp (3)