man3/wmemcmp.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 .\"
  13 .TH WMEMCMP 3  1999-07-25 "GNU" "Linux Programmer's Manual"
  14 .SH NAME
  15 wmemcmp \- compare two arrays of wide-characters
  16 .SH SYNOPSIS
  17 .nf
  18 .B #include <wchar.h>
  19 .sp
  20 .BI "int wmemcmp(const wchar_t *" s1 ", const wchar_t *" s2 ", size_t " n );
  21 .fi
  22 .SH DESCRIPTION
  23 The \fBwmemcmp\fP() function is the wide-character equivalent of the
  24 \fBmemcmp\fP() function.
  25 It compares the \fIn\fP wide-characters starting at \fIs1\fP and the
  26 \fIn\fP wide-characters starting at \fIs2\fP.
  27 .SH "RETURN VALUE"
  28 The \fBwmemcmp\fP() function returns
  29 zero if the wide-character arrays of size
  30 \fIn\fP at \fIs1\fP and \fIs2\fP are equal.
  31 It returns an integer greater than
  32 zero if at the first differing position \fIi\fP (\fIi\fP < \fIn\fP), the
  33 corresponding wide-character \fIs1[i]\fP is greater than \fIs2[i]\fP.
  34 It returns an integer less than zero if
  35 at the first differing position \fIi\fP
  36 (\fIi\fP < \fIn\fP), the corresponding
  37 wide-character \fIs1[i]\fP is less than
  38 \fIs2[i]\fP.
  39 .SH "CONFORMING TO"
  40 C99.
  41 .SH "SEE ALSO"
  42 .BR memcmp (3),
  43 .BR wcscmp (3)