xref: /freebsd/lib/libc/string/strcoll.3 (revision 1db64f89363c97858961c4df0b7d02f3223723cf)
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.Dd June 4, 1993
33.Dt STRCOLL 3
34.Os
35.Sh NAME
36.Nm strcoll
37.Nd compare strings according to current collation
38.Sh LIBRARY
39.Lb libc
40.Sh SYNOPSIS
41.In string.h
42.Ft int
43.Fn strcoll "const char *s1" "const char *s2"
44.Ft int
45.Fn strcoll_l "const char *s1" "const char *s2" "locale_t loc"
46.Sh DESCRIPTION
47The
48.Fn strcoll
49function
50lexicographically compares the null-terminated strings
51.Fa s1
52and
53.Fa s2
54according to the current locale collation
55and returns an integer greater than, equal to, or less than 0,
56depending on whether
57.Fa s1
58is greater than, equal to, or less than
59.Fa s2 .
60If information about the current locale collation is not available,
61the value of
62.Fn strcmp s1 s2
63is returned.
64The
65.Fn strcoll_l
66function uses an explicit locale argument rather than the system locale.
67.Sh SEE ALSO
68.Xr setlocale 3 ,
69.Xr strcmp 3 ,
70.Xr strxfrm 3 ,
71.Xr wcscoll 3
72.Sh STANDARDS
73The
74.Fn strcoll
75function conforms to
76.St -isoC .
77The
78.Fn strcoll_l
79function conforms to
80.St -p1003.1-2008 .
81