]> git.saurik.com Git - apple/libc.git/blobdiff - string/FreeBSD/strcoll.3
Libc-1439.40.11.tar.gz
[apple/libc.git] / string / FreeBSD / strcoll.3
index d2e1ae47c681e293742209a82b63e81e3a898ba5..fcbbbe1d663213f82767281a512a41bc9d8171a7 100644 (file)
 .\" 2. Redistributions in binary form must reproduce the above copyright
 .\"    notice, this list of conditions and the following disclaimer in the
 .\"    documentation and/or other materials provided with the distribution.
-.\" 3. All advertising materials mentioning features or use of this software
-.\"    must display the following acknowledgement:
-.\"    This product includes software developed by the University of
-.\"    California, Berkeley and its contributors.
 .\" 4. Neither the name of the University nor the names of its contributors
 .\"    may be used to endorse or promote products derived from this software
 .\"    without specific prior written permission.
 .\" SUCH DAMAGE.
 .\"
 .\"     @(#)strcoll.3  8.1 (Berkeley) 6/4/93
-.\" $FreeBSD: src/lib/libc/string/strcoll.3,v 1.12 2002/10/15 10:11:53 tjr Exp $
+.\" $FreeBSD: src/lib/libc/string/strcoll.3,v 1.14 2007/01/09 00:28:12 imp Exp $
 .\"
 .Dd June 4, 1993
 .Dt STRCOLL 3
 .Os
 .Sh NAME
-.Nm strcoll
-.Nd compare strings according to current collation
+.Nm strcoll ,
+.Nm strcoll_l
+.Nd compare strings, according to current collation
 .Sh LIBRARY
 .Lb libc
 .Sh SYNOPSIS
 .In string.h
 .Ft int
-.Fn strcoll "const char *s1" "const char *s2"
+.Fo strcoll
+.Fa "const char *s1"
+.Fa "const char *s2"
+.Fc
+.In string.h
+.In xlocale.h
+.Ft int
+.Fo strcoll_l
+.Fa "const char *s1"
+.Fa "const char *s2"
+.Fa "locale_t loc"
+.Fc
 .Sh DESCRIPTION
 The
 .Fn strcoll
@@ -56,18 +64,30 @@ lexicographically compares the null-terminated strings
 .Fa s1
 and
 .Fa s2
-according to the current locale collation if any, otherwise call
-.Fa strcmp ,
+according to the current locale collation
 and returns an integer greater than, equal to, or less than 0,
 according as
 .Fa s1
 is greater than, equal to, or less than
 .Fa s2 .
+If information about the current locale collation is not available,
+the value of
+.Fn strcmp s1 s2
+is returned.
+.Pp
+Although the
+.Fn strcoll
+function uses the current locale, the
+.Fn strcoll_l
+function may be passed a locale directly. See
+.Xr xlocale 3
+for more information.
 .Sh SEE ALSO
 .Xr setlocale 3 ,
 .Xr strcmp 3 ,
 .Xr strxfrm 3 ,
-.Xr wcscoll 3
+.Xr wcscoll 3 ,
+.Xr xlocale 3
 .Sh STANDARDS
 The
 .Fn strcoll