string/FreeBSD/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 .\" 4. 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: src/lib/libc/string/strcoll.3,v 1.14 2007/01/09 00:28:12 imp Exp $
  34 .\"
  35 .Dd June 4, 1993
  36 .Dt STRCOLL 3
  37 .Os
  38 .Sh NAME
  39 .Nm strcoll ,
  40 .Nm strcoll_l
  41 .Nd compare strings, according to current collation
  42 .Sh LIBRARY
  43 .Lb libc
  44 .Sh SYNOPSIS
  45 .In string.h
  46 .Ft int
  47 .Fo strcoll
  48 .Fa "const char *s1"
  49 .Fa "const char *s2"
  50 .Fc
  51 .In string.h
  52 .In xlocale.h
  53 .Ft int
  54 .Fo strcoll_l
  55 .Fa "const char *s1"
  56 .Fa "const char *s2"
  57 .Fa "locale_t loc"
  58 .Fc
  59 .Sh DESCRIPTION
  60 The
  61 .Fn strcoll
  62 function
  63 lexicographically compares the null-terminated strings
  64 .Fa s1
  65 and
  66 .Fa s2
  67 according to the current locale collation
  68 and returns an integer greater than, equal to, or less than 0,
  69 according as
  70 .Fa s1
  71 is greater than, equal to, or less than
  72 .Fa s2 .
  73 If information about the current locale collation is not available,
  74 the value of
  75 .Fn strcmp s1 s2
  76 is returned.
  77 .Pp
  78 Although the
  79 .Fn strcoll
  80 function uses the current locale, the
  81 .Fn strcoll_l
  82 function may be passed a locale directly. See
  83 .Xr xlocale 3
  84 for more information.
  85 .Sh SEE ALSO
  86 .Xr setlocale 3 ,
  87 .Xr strcmp 3 ,
  88 .Xr strxfrm 3 ,
  89 .Xr wcscoll 3 ,
  90 .Xr xlocale 3
  91 .Sh STANDARDS
  92 The
  93 .Fn strcoll
  94 function
  95 conforms to
  96 .St -isoC .