[apple/libc.git] / string / FreeBSD / wcscoll.3

.\" Copyright (c) 1990, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" This code is derived from software contributed to Berkeley by
.\" Chris Torek and the American National Standards Committee X3,
.\" on Information Processing Systems.
.\"
.\" 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. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. 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.
.\"
.\"     @(#)strcoll.3	8.1 (Berkeley) 6/4/93
.\" FreeBSD: src/lib/libc/string/strcoll.3,v 1.11 2001/10/01 16:09:00 ru Exp
.\" $FreeBSD: src/lib/libc/string/wcscoll.3,v 1.2 2002/12/09 14:04:05 ru Exp $
.\"
.Dd October 4, 2002
.Dt WCSCOLL 3
.Os
.Sh NAME
.Nm wcscoll
.Nd compare wide strings according to current collation
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In wchar.h
.Ft int
.Fn wcscoll "const wchar_t *s1" "const wchar_t *s2"
.Sh DESCRIPTION
The
.Fn wcscoll
function compares the null-terminated strings
.Fa s1
and
.Fa s2
according to the current locale collation order.
In the
.Dq Li C
locale,
.Fn wcscoll
is equivalent to
.Fn wcscmp .
.Sh RETURN VALUES
The
.Fn wcscoll
function
returns an integer greater than, equal to, or less than 0,
if
.Fa s1
is greater than, equal to, or less than
.Fa s2 .
.Pp
No return value is reserved to indicate errors;
callers should set
.Va errno
to 0 before calling
.Fn wcscoll .
If it is non-zero upon return from
.Fn wcscoll ,
an error has occurred.
.Sh ERRORS
The
.Fn wcscoll
function will fail if:
.Bl -tag -width Er
.It Bq Er EILSEQ
An invalid wide character code was specified.
.It Bq Er ENOMEM
Cannot allocate enough memory for temporary buffers.
.El
.Sh SEE ALSO
.Xr setlocale 3 ,
.Xr strcoll 3 ,
.Xr wcscmp 3 ,
.Xr wcsxfrm 3
.Sh STANDARDS
The
.Fn wcscoll
function
conforms to
.St -isoC-99 .
.Sh BUGS
The current implementation of
.Fn wcscoll
only works in single-byte
.Dv LC_CTYPE
locales, and falls back to using
.Fn wcscmp
in locales with extended character sets.
Commit	Line	Data
5b2abdfb	1	.\" Copyright (c) 1990, 1991, 1993
e9ce8d39 A	2	.\" The Regents of the University of California. All rights reserved.
e9ce8d39 A	3	.\"
5b2abdfb A	4	.\" This code is derived from software contributed to Berkeley by
	5	.\" Chris Torek and the American National Standards Committee X3,
	6	.\" on Information Processing Systems.
	7	.\"
e9ce8d39 A	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. All advertising materials mentioning features or use of this software
	17	.\" must display the following acknowledgement:
	18	.\" This product includes software developed by the University of
	19	.\" California, Berkeley and its contributors.
	20	.\" 4. Neither the name of the University nor the names of its contributors
	21	.\" may be used to endorse or promote products derived from this software
	22	.\" without specific prior written permission.
	23	.\"
	24	.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	25	.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	26	.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	27	.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	28	.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	29	.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	30	.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	31	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	32	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	33	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	34	.\" SUCH DAMAGE.
	35	.\"
5b2abdfb	36	.\" @(#)strcoll.3 8.1 (Berkeley) 6/4/93
9385eb3d A	37	.\" FreeBSD: src/lib/libc/string/strcoll.3,v 1.11 2001/10/01 16:09:00 ru Exp
9385eb3d A	38	.\" $FreeBSD: src/lib/libc/string/wcscoll.3,v 1.2 2002/12/09 14:04:05 ru Exp $
e9ce8d39	39	.\"
9385eb3d A	40	.Dd October 4, 2002
9385eb3d A	41	.Dt WCSCOLL 3
e9ce8d39 A	42	.Os
e9ce8d39 A	43	.Sh NAME
9385eb3d A	44	.Nm wcscoll
9385eb3d A	45	.Nd compare wide strings according to current collation
e9ce8d39 A	46	.Sh LIBRARY
	47	.Lb libc
	48	.Sh SYNOPSIS
9385eb3d	49	.In wchar.h
e9ce8d39	50	.Ft int
9385eb3d	51	.Fn wcscoll "const wchar_t s1" "const wchar_t s2"
e9ce8d39 A	52	.Sh DESCRIPTION
e9ce8d39 A	53	The
9385eb3d A	54	.Fn wcscoll
9385eb3d A	55	function compares the null-terminated strings
5b2abdfb	56	.Fa s1
e9ce8d39	57	and
5b2abdfb	58	.Fa s2
9385eb3d A	59	according to the current locale collation order.
	60	In the
	61	.Dq Li C
	62	locale,
	63	.Fn wcscoll
	64	is equivalent to
	65	.Fn wcscmp .
	66	.Sh RETURN VALUES
	67	The
	68	.Fn wcscoll
	69	function
	70	returns an integer greater than, equal to, or less than 0,
	71	if
5b2abdfb A	72	.Fa s1
	73	is greater than, equal to, or less than
	74	.Fa s2 .
9385eb3d A	75	.Pp
	76	No return value is reserved to indicate errors;
	77	callers should set
	78	.Va errno
	79	to 0 before calling
	80	.Fn wcscoll .
	81	If it is non-zero upon return from
	82	.Fn wcscoll ,
	83	an error has occurred.
	84	.Sh ERRORS
	85	The
	86	.Fn wcscoll
	87	function will fail if:
	88	.Bl -tag -width Er
	89	.It Bq Er EILSEQ
	90	An invalid wide character code was specified.
	91	.It Bq Er ENOMEM
	92	Cannot allocate enough memory for temporary buffers.
	93	.El
e9ce8d39	94	.Sh SEE ALSO
5b2abdfb	95	.Xr setlocale 3 ,
9385eb3d A	96	.Xr strcoll 3 ,
	97	.Xr wcscmp 3 ,
	98	.Xr wcsxfrm 3
5b2abdfb	99	.Sh STANDARDS
e9ce8d39	100	The
9385eb3d	101	.Fn wcscoll
5b2abdfb A	102	function
5b2abdfb A	103	conforms to
9385eb3d A	104	.St -isoC-99 .
	105	.Sh BUGS
	106	The current implementation of
	107	.Fn wcscoll
	108	only works in single-byte
	109	.Dv LC_CTYPE
	110	locales, and falls back to using
	111	.Fn wcscmp
	112	in locales with extended character sets.