xref: /freebsd/lib/libc/string/strcoll.3 (revision c2bfae006a3feffafec5acb8e4ae77829b6f025f)
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.
167b7aeeccSAndrey A. Chernov.\" 3. All advertising materials mentioning features or use of this software
177b7aeeccSAndrey A. Chernov.\"    must display the following acknowledgement:
187b7aeeccSAndrey A. Chernov.\"	This product includes software developed by the University of
197b7aeeccSAndrey A. Chernov.\"	California, Berkeley and its contributors.
207b7aeeccSAndrey A. Chernov.\" 4. Neither the name of the University nor the names of its contributors
217b7aeeccSAndrey A. Chernov.\"    may be used to endorse or promote products derived from this software
227b7aeeccSAndrey A. Chernov.\"    without specific prior written permission.
2358f0484fSRodney W. Grimes.\"
247b7aeeccSAndrey A. Chernov.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
2558f0484fSRodney W. Grimes.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
2658f0484fSRodney W. Grimes.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
277b7aeeccSAndrey A. Chernov.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
2858f0484fSRodney W. Grimes.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
2958f0484fSRodney W. Grimes.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
3058f0484fSRodney W. Grimes.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
3158f0484fSRodney W. Grimes.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
3258f0484fSRodney W. Grimes.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
3358f0484fSRodney W. Grimes.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
3458f0484fSRodney W. Grimes.\" SUCH DAMAGE.
3558f0484fSRodney W. Grimes.\"
367b7aeeccSAndrey A. Chernov.\"     @(#)strcoll.3	8.1 (Berkeley) 6/4/93
377b7aeeccSAndrey A. Chernov.\"
387b7aeeccSAndrey A. Chernov.Dd June 4, 1993
3958f0484fSRodney W. Grimes.Dt STRCOLL 3
4058f0484fSRodney W. Grimes.Os
4158f0484fSRodney W. Grimes.Sh NAME
4258f0484fSRodney W. Grimes.Nm strcoll
4358f0484fSRodney W. Grimes.Nd compare strings according to current collation
4458f0484fSRodney W. Grimes.Sh SYNOPSIS
4558f0484fSRodney W. Grimes.Fd #include <string.h>
4658f0484fSRodney W. Grimes.Ft int
4758f0484fSRodney W. Grimes.Fn strcoll "const char *s1" "const char *s2"
4858f0484fSRodney W. Grimes.Sh DESCRIPTION
4958f0484fSRodney W. GrimesThe
5058f0484fSRodney W. Grimes.Fn strcoll
5158f0484fSRodney W. Grimesfunction
5258f0484fSRodney W. Grimeslexicographically compares the null-terminated strings
5358f0484fSRodney W. Grimes.Fa s1
5458f0484fSRodney W. Grimesand
5558f0484fSRodney W. Grimes.Fa s2
56c2bfae00SAndrey A. Chernovaccording to the current locale collation if any, otherwise call
57c2bfae00SAndrey A. Chernov.Fa strcmp ,
58c2bfae00SAndrey A. Chernovand returns an integer greater than, equal to, or less than 0,
59c2bfae00SAndrey A. Chernovaccording as
60c2bfae00SAndrey A. Chernov.Fa s1
61c2bfae00SAndrey A. Chernovis greater than, equal to, or less than
62c2bfae00SAndrey A. Chernov.Fa s2 .
6358f0484fSRodney W. Grimes.Sh SEE ALSO
6458f0484fSRodney W. Grimes.Xr setlocale 3 ,
6558f0484fSRodney W. Grimes.Xr strcmp 3 ,
6658f0484fSRodney W. Grimes.Xr strxfrm 3
6758f0484fSRodney W. Grimes.Sh STANDARDS
6858f0484fSRodney W. GrimesThe
6958f0484fSRodney W. Grimes.Fn strcoll
7058f0484fSRodney W. Grimesfunction
7158f0484fSRodney W. Grimesconforms to
7258f0484fSRodney W. Grimes.St -ansiC .
73