1.\" Copyright (c) 1990, 1991, 1993 2.\" The Regents of the University of California. All rights reserved. 3.\" 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.\" 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.\" 36.\" @(#)strcoll.3 8.1 (Berkeley) 6/4/93 37.\" FreeBSD: src/lib/libc/string/strcoll.3,v 1.11 2001/10/01 16:09:00 ru Exp 38.\" $FreeBSD$ 39.\" 40.Dd October 4, 2002 41.Dt WCSCOLL 3 42.Os 43.Sh NAME 44.Nm wcscoll 45.Nd compare wide strings according to current collation 46.Sh LIBRARY 47.Lb libc 48.Sh SYNOPSIS 49.In wchar.h 50.Ft int 51.Fn wcscoll "const wchar_t *s1" "const wchar_t *s2" 52.Sh DESCRIPTION 53The 54.Fn wcscoll 55function compares the null-terminated strings 56.Fa s1 57and 58.Fa s2 59according to the current locale collation order. 60In the 61.Dq Li C 62locale, 63.Fn wcscoll 64is equivalent to 65.Fn wcscmp . 66.Sh RETURN VALUES 67The 68.Fn wcscoll 69function 70returns an integer greater than, equal to, or less than 0, 71if 72.Fa s1 73is greater than, equal to, or less than 74.Fa s2 . 75.Pp 76No return value is reserved to indicate errors; 77callers should set 78.Va errno 79to 0 before calling 80.Fn wcscoll . 81If it is non-zero upon return from 82.Fn wcscoll , 83an error has occurred. 84.Sh ERRORS 85The 86.Fn wcscoll 87function will fail if: 88.Bl -tag -width Er 89.It Bq Er EILSEQ 90An invalid wide character code was specified. 91.It Bq Er ENOMEM 92Cannot allocate enough memory for temporary buffers. 93.El 94.Sh SEE ALSO 95.Xr setlocale 3 , 96.Xr strcoll 3 , 97.Xr wcscmp 3 , 98.Xr wcsxfrm 3 99.Sh STANDARDS 100The 101.Fn wcscoll 102function 103conforms to 104.St -isoC-99 . 105.Sh BUGS 106The current implementation of 107.Fn wcscoll 108only works in single-byte 109.Dv LC_CTYPE 110locales, and falls back to using 111.Fn wcscmp 112in locales with extended character sets. 113