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