original/man3/strcoll.3

   1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
   2 .\"
   3 .\" %%%LICENSE_START(VERBATIM)
   4 .\" Permission is granted to make and distribute verbatim copies of this
   5 .\" manual provided the copyright notice and this permission notice are
   6 .\" preserved on all copies.
   7 .\"
   8 .\" Permission is granted to copy and distribute modified versions of this
   9 .\" manual under the conditions for verbatim copying, provided that the
  10 .\" entire resulting derived work is distributed under the terms of a
  11 .\" permission notice identical to this one.
  12 .\"
  13 .\" Since the Linux kernel and libraries are constantly changing, this
  14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  15 .\" responsibility for errors or omissions, or for damages resulting from
  16 .\" the use of the information contained herein.  The author(s) may not
  17 .\" have taken the same level of care in the production of this manual,
  18 .\" which is licensed free of charge, as they might when working
  19 .\" professionally.
  20 .\"
  21 .\" Formatted or processed versions of this manual, if unaccompanied by
  22 .\" the source, must acknowledge the copyright and authors of this work.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .\" References consulted:
  26 .\"     Linux libc source code
  27 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
  28 .\"     386BSD man pages
  29 .\" Modified Sun Jul 25 10:40:44 1993 by Rik Faith (faith@cs.unc.edu)
  30 .TH STRCOLL 3  2010-09-20 "GNU" "Linux Programmer's Manual"
  31 .SH NAME
  32 strcoll \- compare two strings using the current locale
  33 .SH SYNOPSIS
  34 .nf
  35 .B #include <string.h>
  36 .sp
  37 .BI "int strcoll(const char *" s1 ", const char *" s2 );
  38 .fi
  39 .SH DESCRIPTION
  40 The
  41 .BR strcoll ()
  42 function compares the two strings
  43 .I s1
  44 and
  45 .IR s2 .
  46 It returns an integer less than, equal to, or greater
  47 than zero if
  48 .I s1
  49 is found, respectively, to be less than,
  50 to match, or be greater than
  51 .IR s2 .
  52 The comparison is based on
  53 strings interpreted as appropriate for the program's current locale
  54 for category
  55 .BR LC_COLLATE .
  56 (See
  57 .BR setlocale (3).)
  58 .SH RETURN VALUE
  59 The
  60 .BR strcoll ()
  61 function returns an integer less than, equal to,
  62 or greater than zero if
  63 .I s1
  64 is found, respectively, to be less
  65 than, to match, or be greater than
  66 .IR s2 ,
  67 when both are interpreted
  68 as appropriate for the current locale.
  69 .SH CONFORMING TO
  70 SVr4, 4.3BSD, C89, C99.
  71 .SH NOTES
  72 In the
  73 .I "POSIX"
  74 or
  75 .I "C"
  76 locales
  77 .BR strcoll ()
  78 is equivalent to
  79 .BR strcmp (3).
  80 .SH SEE ALSO
  81 .BR bcmp (3),
  82 .BR memcmp (3),
  83 .BR setlocale (3),
  84 .BR strcasecmp (3),
  85 .BR strcmp (3),
  86 .BR string (3),
  87 .BR strxfrm (3)
  88 .SH COLOPHON
  89 This page is part of release 3.79 of the Linux
  90 .I man-pages
  91 project.
  92 A description of the project,
  93 information about reporting bugs,
  94 and the latest version of this page,
  95 can be found at
  96 \%http://www.kernel.org/doc/man\-pages/.