original/man3/wcscmp.3

   1 .\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
   2 .\"
   3 .\" %%%LICENSE_START(GPLv2+_DOC_ONEPARA)
   4 .\" This is free documentation; you can redistribute it and/or
   5 .\" modify it under the terms of the GNU General Public License as
   6 .\" published by the Free Software Foundation; either version 2 of
   7 .\" the License, or (at your option) any later version.
   8 .\" %%%LICENSE_END
   9 .\"
  10 .\" References consulted:
  11 .\"   GNU glibc-2 source code and manual
  12 .\"   Dinkumware C library reference http://www.dinkumware.com/
  13 .\"   OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html
  14 .\"   ISO/IEC 9899:1999
  15 .\"
  16 .TH WCSCMP 3  1999-07-25 "GNU" "Linux Programmer's Manual"
  17 .SH NAME
  18 wcscmp \- compare two wide-character strings
  19 .SH SYNOPSIS
  20 .nf
  21 .B #include <wchar.h>
  22 .sp
  23 .BI "int wcscmp(const wchar_t *" s1 ", const wchar_t *" s2 );
  24 .fi
  25 .SH DESCRIPTION
  26 The
  27 .BR wcscmp ()
  28 function is the wide-character equivalent
  29 of the
  30 .BR strcmp (3)
  31 function.
  32 It compares the wide-character string pointed to by
  33 .I s1
  34 and the
  35 wide-character string pointed to by
  36 .IR s2 .
  37 .SH RETURN VALUE
  38 The
  39 .BR wcscmp ()
  40 function returns zero if the wide-character strings at
  41 .I s1
  42 and
  43 .I s2
  44 are equal.
  45 It returns an integer greater than zero if
  46 at the first differing position
  47 .IR i ,
  48 the corresponding wide-character
  49 .I s1[i]
  50 is greater than
  51 .IR s2[i] .
  52 It returns an integer less than zero if
  53 at the first differing position
  54 .IR i ,
  55 the corresponding wide-character
  56 .I s1[i]
  57 is less than
  58 .IR s2[i] .
  59 .SH CONFORMING TO
  60 C99.
  61 .SH SEE ALSO
  62 .BR strcmp (3),
  63 .BR wcscasecmp (3),
  64 .BR wmemcmp (3)