Debian Codegraph @

upstream/debian-trixie/man3/wcscmp.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 .\" ISO/IEC 9899:1999
11 .\"
12 .TH wcscmp 3 2024-05-02 "Linux man-pages 6.9.1"
13 .SH NAME
14 wcscmp \- compare two wide-character strings
15 .SH LIBRARY
16 Standard C library
17 .RI ( libc ", " \-lc )
18 .SH SYNOPSIS
19 .nf
20 .B #include <wchar.h>
21 .P
22 .BI "int wcscmp(const wchar_t *" s1 ", const wchar_t *" s2 );
23 .fi
24 .SH DESCRIPTION
25 The
26 .BR wcscmp ()
27 function is the wide-character equivalent
28 of the
29 .BR strcmp (3)
30 function.
31 It compares the wide-character string pointed to by
32 .I s1
33 and the
34 wide-character string pointed to by
35 .IR s2 .
36 .SH RETURN VALUE
37 The
38 .BR wcscmp ()
39 function returns zero if the wide-character strings at
40 .I s1
41 and
42 .I s2
43 are equal.
44 It returns an integer greater than zero if
45 at the first differing position
46 .IR i ,
47 the corresponding wide-character
48 .I s1[i]
49 is greater than
50 .IR s2[i] .
51 It returns an integer less than zero if
52 at the first differing position
53 .IR i ,
54 the corresponding wide-character
55 .I s1[i]
56 is less than
57 .IR s2[i] .
58 .SH ATTRIBUTES
59 For an explanation of the terms used in this section, see
60 .BR attributes (7).
61 .TS
62 allbox;
63 lbx lb lb
64 l l l.
65 Interface Attribute Value
66 T{
67 .na
68 .nh
69 .BR wcscmp ()
70 T} Thread safety MT-Safe
71 .TE
72 .SH STANDARDS
73 C11, POSIX.1-2008.
74 .SH HISTORY
75 POSIX.1-2001, C99.
76 .SH SEE ALSO
77 .BR strcmp (3),
78 .BR wcscasecmp (3),
79 .BR wmemcmp (3)