1.\" $OpenBSD: wcscoll.3,v 1.2 2019/01/18 07:43:36 schwarze Exp $ 2.\" 3.\" Copyright (c) 1990, 1991 The Regents of the University of California. 4.\" Copyright (c) 2017 Ingo Schwarze <schwarze@openbsd.org> 5.\" All rights reserved. 6.\" 7.\" This code is derived from software contributed to Berkeley by 8.\" Chris Torek and the American National Standards Committee X3, 9.\" on Information Processing Systems. 10.\" 11.\" Redistribution and use in source and binary forms, with or without 12.\" modification, are permitted provided that the following conditions 13.\" are met: 14.\" 1. Redistributions of source code must retain the above copyright 15.\" notice, this list of conditions and the following disclaimer. 16.\" 2. Redistributions in binary form must reproduce the above copyright 17.\" notice, this list of conditions and the following disclaimer in the 18.\" documentation and/or other materials provided with the distribution. 19.\" 3. Neither the name of the University nor the names of its contributors 20.\" may be used to endorse or promote products derived from this software 21.\" without specific prior written permission. 22.\" 23.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 24.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 25.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 26.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 27.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 28.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 29.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 30.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 31.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 32.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 33.\" SUCH DAMAGE. 34.\" 35.Dd $Mdocdate: January 18 2019 $ 36.Dt WCSCOLL 3 37.Os 38.Sh NAME 39.Nm wcscoll , 40.Nm wcscoll_l 41.Nd compare wide strings according to the current collation 42.Sh SYNOPSIS 43.In wchar.h 44.Ft int 45.Fn wcscoll "const wchar_t *s1" "const wchar_t *s2" 46.Ft int 47.Fn wcscoll_l "const wchar_t *s1" "const wchar_t *s2" "locale_t locale" 48.Sh DESCRIPTION 49The 50.Fn wcscoll 51and 52.Fn wcscoll_l 53functions lexicographically compare the NUL-terminated wide strings 54.Fa s1 55and 56.Fa s2 57according to the current locale collation 58and return an integer greater than, equal to, or less than 0, 59according to whether 60.Fa s1 61is greater than, equal to, or less than 62.Fa s2 . 63.Pp 64On 65.Ox , 66they have the same effect as 67.Xr wcscmp 3 , 68and the global locale, the thread-specific locale, and the 69.Fa locale 70argument are ignored. 71On other operating systems, the results may depend on the 72.Dv LC_CTYPE 73and 74.Dv LC_COLLATE 75locale categories set with 76.Xr setlocale 3 , 77.Xr uselocale 3 , 78or 79.Xr newlocale 3 . 80.Sh SEE ALSO 81.Xr newlocale 3 , 82.Xr setlocale 3 , 83.Xr wcscmp 3 , 84.Xr wcsxfrm 3 85.Sh STANDARDS 86The 87.Fn wcscoll 88function conforms to 89.St -isoC-99 , 90and 91.Fn wcscoll_l 92to 93.St -p1003.1-2008 . 94.Sh HISTORY 95The 96.Fn wcscoll 97function has been available since 98.Ox 4.8 , 99and 100.Fn wcscoll_l 101since 102.Ox 6.2 . 103