original/man3/wcscmp.3

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