]> git.ipfire.org Git - thirdparty/man-pages.git/blame - man3/wmemcmp.3
user_namespaces.7: Minor rewordings of recently added text
[thirdparty/man-pages.git] / man3 / wmemcmp.3
CommitLineData
fea681da
MK
1.\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
2.\"
89e3ffe9 3.\" %%%LICENSE_START(GPLv2+_DOC_ONEPARA)
fea681da
MK
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.
fe382ebf 8.\" %%%LICENSE_END
fea681da
MK
9.\"
10.\" References consulted:
11.\" GNU glibc-2 source code and manual
12.\" Dinkumware C library reference http://www.dinkumware.com/
008f1ecc 13.\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html
fea681da 14.\"
460495ca 15.TH WMEMCMP 3 2015-08-08 "GNU" "Linux Programmer's Manual"
fea681da
MK
16.SH NAME
17wmemcmp \- compare two arrays of wide-characters
18.SH SYNOPSIS
19.nf
20.B #include <wchar.h>
68e4db0a 21.PP
fea681da
MK
22.BI "int wmemcmp(const wchar_t *" s1 ", const wchar_t *" s2 ", size_t " n );
23.fi
24.SH DESCRIPTION
60a90ecd
MK
25The
26.BR wmemcmp ()
27function is the wide-character equivalent of the
28.BR memcmp (3)
29function.
35cfd378 30It compares the
51700fd7 31.IR n
35cfd378
MK
32wide-characters starting at
33.I s1
34and the
35.I n
36wide-characters starting at
37.IR s2 .
47297adb 38.SH RETURN VALUE
60a90ecd
MK
39The
40.BR wmemcmp ()
41function returns
c13182ef 42zero if the wide-character arrays of size
35cfd378
MK
43.I n
44at
51700fd7 45.IR s1
35cfd378
MK
46and
47.I s2
48are equal.
c13182ef 49It returns an integer greater than
35cfd378
MK
50zero if at the first differing position
51.I i
52.RI ( i " <"
53.IR n ),
54the
55corresponding wide-character
56.I s1[i]
57is greater than
58.IR s2[i] .
c13182ef 59It returns an integer less than zero if
35cfd378
MK
60at the first differing position
61.I i
287bfbdb
MK
62.RI ( i
63<
35cfd378
MK
64.IR n ),
65the corresponding
287bfbdb
MK
66wide-character
67.I s1[i]
68is less than
69.IR s2[i] .
500d891e 70.SH ATTRIBUTES
2aba859b
PH
71For an explanation of the terms used in this section, see
72.BR attributes (7).
73.TS
74allbox;
75lb lb lb
76l l l.
77Interface Attribute Value
78T{
500d891e 79.BR wmemcmp ()
2aba859b
PH
80T} Thread safety MT-Safe
81.TE
47297adb 82.SH CONFORMING TO
b84a2232 83POSIX.1-2001, POSIX.1-2008, C99.
47297adb 84.SH SEE ALSO
fea681da
MK
85.BR memcmp (3),
86.BR wcscmp (3)