original/man3/wmemcmp.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 .\"
  15 .TH WMEMCMP 3  2013-11-05 "GNU" "Linux Programmer's Manual"
  16 .SH NAME
  17 wmemcmp \- compare two arrays of wide-characters
  18 .SH SYNOPSIS
  19 .nf
  20 .B #include <wchar.h>
  21 .sp
  22 .BI "int wmemcmp(const wchar_t *" s1 ", const wchar_t *" s2 ", size_t " n );
  23 .fi
  24 .SH DESCRIPTION
  25 The
  26 .BR wmemcmp ()
  27 function is the wide-character equivalent of the
  28 .BR memcmp (3)
  29 function.
  30 It compares the
  31 .IR n
  32 wide-characters starting at
  33 .I s1
  34 and the
  35 .I n
  36 wide-characters starting at
  37 .IR s2 .
  38 .SH RETURN VALUE
  39 The
  40 .BR wmemcmp ()
  41 function returns
  42 zero if the wide-character arrays of size
  43 .I n
  44 at
  45 .IR s1
  46 and
  47 .I s2
  48 are equal.
  49 It returns an integer greater than
  50 zero if at the first differing position
  51 .I i
  52 .RI ( i " <"
  53 .IR n ),
  54 the
  55 corresponding wide-character
  56 .I s1[i]
  57 is greater than
  58 .IR s2[i] .
  59 It returns an integer less than zero if
  60 at the first differing position
  61 .I i
  62 .RI ( i
  63 <
  64 .IR n ),
  65 the corresponding
  66 wide-character
  67 .I s1[i]
  68 is less than
  69 .IR s2[i] .
  70 .SH ATTRIBUTES
  71 .SS Multithreading (see pthreads(7))
  72 The
  73 .BR wmemcmp ()
  74 function is thread-safe.
  75 .SH CONFORMING TO
  76 C99.
  77 .SH SEE ALSO
  78 .BR memcmp (3),
  79 .BR wcscmp (3)
  80 .SH COLOPHON
  81 This page is part of release 3.79 of the Linux
  82 .I man-pages
  83 project.
  84 A description of the project,
  85 information about reporting bugs,
  86 and the latest version of this page,
  87 can be found at
  88 \%http://www.kernel.org/doc/man\-pages/.