xref: /freebsd/lib/libc/string/strcoll.3 (revision dc36d6f9bb1753f3808552f3afd30eda9a7b206a)
17b7aeeccSAndrey A. Chernov.\" Copyright (c) 1990, 1991, 1993
27b7aeeccSAndrey A. Chernov.\"	The Regents of the University of California.  All rights reserved.
37b7aeeccSAndrey A. Chernov.\"
47b7aeeccSAndrey A. Chernov.\" This code is derived from software contributed to Berkeley by
57b7aeeccSAndrey A. Chernov.\" Chris Torek and the American National Standards Committee X3,
67b7aeeccSAndrey A. Chernov.\" on Information Processing Systems.
758f0484fSRodney W. Grimes.\"
858f0484fSRodney W. Grimes.\" Redistribution and use in source and binary forms, with or without
958f0484fSRodney W. Grimes.\" modification, are permitted provided that the following conditions
1058f0484fSRodney W. Grimes.\" are met:
1158f0484fSRodney W. Grimes.\" 1. Redistributions of source code must retain the above copyright
1258f0484fSRodney W. Grimes.\"    notice, this list of conditions and the following disclaimer.
1358f0484fSRodney W. Grimes.\" 2. Redistributions in binary form must reproduce the above copyright
1458f0484fSRodney W. Grimes.\"    notice, this list of conditions and the following disclaimer in the
1558f0484fSRodney W. Grimes.\"    documentation and/or other materials provided with the distribution.
16*3fb3b97cSEd Maste.\" 3. Neither the name of the University nor the names of its contributors
177b7aeeccSAndrey A. Chernov.\"    may be used to endorse or promote products derived from this software
187b7aeeccSAndrey A. Chernov.\"    without specific prior written permission.
1958f0484fSRodney W. Grimes.\"
207b7aeeccSAndrey A. Chernov.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
2158f0484fSRodney W. Grimes.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
2258f0484fSRodney W. Grimes.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
237b7aeeccSAndrey A. Chernov.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
2458f0484fSRodney W. Grimes.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
2558f0484fSRodney W. Grimes.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
2658f0484fSRodney W. Grimes.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
2758f0484fSRodney W. Grimes.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
2858f0484fSRodney W. Grimes.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
2958f0484fSRodney W. Grimes.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
3058f0484fSRodney W. Grimes.\" SUCH DAMAGE.
3158f0484fSRodney W. Grimes.\"
327b7aeeccSAndrey A. Chernov.Dd June 4, 1993
3358f0484fSRodney W. Grimes.Dt STRCOLL 3
3458f0484fSRodney W. Grimes.Os
3558f0484fSRodney W. Grimes.Sh NAME
3658f0484fSRodney W. Grimes.Nm strcoll
3758f0484fSRodney W. Grimes.Nd compare strings according to current collation
3825bb73e0SAlexey Zelkin.Sh LIBRARY
3925bb73e0SAlexey Zelkin.Lb libc
4058f0484fSRodney W. Grimes.Sh SYNOPSIS
4132eef9aeSRuslan Ermilov.In string.h
4258f0484fSRodney W. Grimes.Ft int
4358f0484fSRodney W. Grimes.Fn strcoll "const char *s1" "const char *s2"
44db356f03SIsabell Long.Ft int
45db356f03SIsabell Long.Fn strcoll_l "const char *s1" "const char *s2" "locale_t loc"
4658f0484fSRodney W. Grimes.Sh DESCRIPTION
4758f0484fSRodney W. GrimesThe
4858f0484fSRodney W. Grimes.Fn strcoll
4958f0484fSRodney W. Grimesfunction
5058f0484fSRodney W. Grimeslexicographically compares the null-terminated strings
5158f0484fSRodney W. Grimes.Fa s1
5258f0484fSRodney W. Grimesand
5358f0484fSRodney W. Grimes.Fa s2
5401510e40SDima Dorfmanaccording to the current locale collation
55c2bfae00SAndrey A. Chernovand returns an integer greater than, equal to, or less than 0,
56db356f03SIsabell Longdepending on whether
57c2bfae00SAndrey A. Chernov.Fa s1
58c2bfae00SAndrey A. Chernovis greater than, equal to, or less than
59c2bfae00SAndrey A. Chernov.Fa s2 .
6001510e40SDima DorfmanIf information about the current locale collation is not available,
6101510e40SDima Dorfmanthe value of
6201510e40SDima Dorfman.Fn strcmp s1 s2
6301510e40SDima Dorfmanis returned.
64db356f03SIsabell LongThe
65db356f03SIsabell Long.Fn strcoll_l
66db356f03SIsabell Longfunction uses an explicit locale argument rather than the system locale.
6758f0484fSRodney W. Grimes.Sh SEE ALSO
6858f0484fSRodney W. Grimes.Xr setlocale 3 ,
6958f0484fSRodney W. Grimes.Xr strcmp 3 ,
702fe3e5cdSTim J. Robbins.Xr strxfrm 3 ,
712fe3e5cdSTim J. Robbins.Xr wcscoll 3
7258f0484fSRodney W. Grimes.Sh STANDARDS
7358f0484fSRodney W. GrimesThe
7458f0484fSRodney W. Grimes.Fn strcoll
75db356f03SIsabell Longfunction conforms to
76588a200cSRuslan Ermilov.St -isoC .
77db356f03SIsabell LongThe
78db356f03SIsabell Long.Fn strcoll_l
79db356f03SIsabell Longfunction conforms to
80db356f03SIsabell Long.St -p1003.1-2008 .
81