man/, share/mk/: Move man*/ to man/

[thirdparty/man-pages.git] / man / man3 / wmemcmp.3

'\" t
.\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
.\"
.\" SPDX-License-Identifier: GPL-2.0-or-later
.\"
.\" References consulted:
.\"   GNU glibc-2 source code and manual
.\"   Dinkumware C library reference http://www.dinkumware.com/
.\"   OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html
.\"
.TH wmemcmp 3 (date) "Linux man-pages (unreleased)"
.SH NAME
wmemcmp \- compare two arrays of wide-characters
.SH LIBRARY
Standard C library
.RI ( libc ", " \-lc )
.SH SYNOPSIS
.nf
.B #include <wchar.h>
.P
.BI "int wmemcmp(const wchar_t " s1 [. n "], const wchar_t " s2 [. n "], \
size_t " n );
.fi
.SH DESCRIPTION
The
.BR wmemcmp ()
function is the wide-character equivalent of the
.BR memcmp (3)
function.
It compares the
.I n
wide-characters starting at
.I s1
and the
.I n
wide-characters starting at
.IR s2 .
.SH RETURN VALUE
The
.BR wmemcmp ()
function returns
zero if the wide-character arrays of size
.I n
at
.I s1
and
.I s2
are equal.
It returns an integer greater than
zero if at the first differing position
.I i
.RI ( i " <"
.IR n ),
the
corresponding wide-character
.I s1[i]
is greater than
.IR s2[i] .
It returns an integer less than zero if
at the first differing position
.I i
.RI ( i
<
.IR n ),
the corresponding
wide-character
.I s1[i]
is less than
.IR s2[i] .
.SH ATTRIBUTES
For an explanation of the terms used in this section, see
.BR attributes (7).
.TS
allbox;
lbx lb lb
l l l.
Interface	Attribute	Value
T{
.na
.nh
.BR wmemcmp ()
T}	Thread safety	MT-Safe
.TE
.SH STANDARDS
C11, POSIX.1-2008.
.SH HISTORY
POSIX.1-2001, C99.
.SH SEE ALSO
.BR memcmp (3),
.BR wcscmp (3)