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