Debian Codegraph @

upstream/debian-trixie/man3/wmemcmp.3

raw
1 '\" t
2 .\" Copyright (c) Bruno Haible <[email protected]>
3 .\"
4 .\" SPDX-License-Identifier: GPL-2.0-or-later
5 .\"
6 .\" References consulted:
7 .\" GNU glibc-2 source code and manual
8 .\" Dinkumware C library reference http://www.dinkumware.com/
9 .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html
10 .\"
11 .TH wmemcmp 3 2024-05-02 "Linux man-pages 6.9.1"
12 .SH NAME
13 wmemcmp \- compare two arrays of wide-characters
14 .SH LIBRARY
15 Standard C library
16 .RI ( libc ", " \-lc )
17 .SH SYNOPSIS
18 .nf
19 .B #include <wchar.h>
20 .P
21 .BI "int wmemcmp(const wchar_t " s1 [. n "], const wchar_t " s2 [. n "], \
22 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 .I 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 .I 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 For an explanation of the terms used in this section, see
72 .BR attributes (7).
73 .TS
74 allbox;
75 lbx lb lb
76 l l l.
77 Interface Attribute Value
78 T{
79 .na
80 .nh
81 .BR wmemcmp ()
82 T} Thread safety MT-Safe
83 .TE
84 .SH STANDARDS
85 C11, POSIX.1-2008.
86 .SH HISTORY
87 POSIX.1-2001, C99.
88 .SH SEE ALSO
89 .BR memcmp (3),
90 .BR wcscmp (3)