manual/LDP_man-pages/original/man3/strcoll.3

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