lib/libc/string/strcoll.3

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