man3/wcscmp.3

   1 .\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
   2 .\"
   3 .\" %%%LICENSE_START(GPLv2+_ONEPARA_DOC)
   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 \fIs1\fP and the
  33 wide-character string pointed to by \fIs2\fP.
  34 .SH RETURN VALUE
  35 The
  36 .BR wcscmp ()
  37 function returns zero if the wide-character strings at
  38 \fIs1\fP and \fIs2\fP are equal.
  39 It returns an integer greater than zero if
  40 at the first differing position \fIi\fP, the corresponding wide-character
  41 \fIs1[i]\fP is greater than \fIs2[i]\fP.
  42 It returns an integer less than zero if
  43 at the first differing position \fIi\fP, the corresponding wide-character
  44 \fIs1[i]\fP is less than \fIs2[i]\fP.
  45 .SH CONFORMING TO
  46 C99.
  47 .SH SEE ALSO
  48 .BR strcmp (3),
  49 .BR wcscasecmp (3),
  50 .BR wmemcmp (3)