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