]> git.ipfire.org Git - thirdparty/man-pages.git/blame - man3/wcsncmp.3
des_crypt.3: Minor wording fix in VERSIONS
[thirdparty/man-pages.git] / man3 / wcsncmp.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
MK
14.\" ISO/IEC 9899:1999
15.\"
9ba01802 16.TH WCSNCMP 3 2019-03-06 "GNU" "Linux Programmer's Manual"
fea681da
MK
17.SH NAME
18wcsncmp \- compare two fixed-size wide-character strings
19.SH SYNOPSIS
20.nf
21.B #include <wchar.h>
68e4db0a 22.PP
fea681da
MK
23.BI "int wcsncmp(const wchar_t *" s1 ", const wchar_t *" s2 ", size_t " n );
24.fi
25.SH DESCRIPTION
60a90ecd
MK
26The
27.BR wcsncmp ()
28function is the wide-character equivalent of the
29.BR strncmp (3)
30function.
40aa0db0
MK
31It compares the wide-character string pointed to by
32.I s1
33and the
34wide-character string pointed to by
35.IR s2 ,
36but at most
37.I n
38wide
c13182ef
MK
39characters from each string.
40In each string, the comparison extends only up
d1a71985 41to the first occurrence of a null wide character (L\(aq\e0\(aq), if any.
47297adb 42.SH RETURN VALUE
60a90ecd
MK
43The
44.BR wcsncmp ()
45function returns zero if the wide-character strings at
40aa0db0
MK
46.I s1
47and
48.IR s2 ,
49truncated to at most length
50.IR n ,
51are equal.
fea681da 52It returns an integer greater than zero if at the first differing position
40aa0db0
MK
53.I i
54.RI ( i
55<
56.IR n ),
57the corresponding wide-character
58.I s1[i]
59is
60greater than
61.IR s2[i] .
c13182ef 62It returns an integer less than zero if at the first
40aa0db0
MK
63differing position
64.I i
2d20cb1b 65.RI ( i
40aa0db0
MK
66<
67.IR n ),
68the corresponding
69wide-character
70.I s1[i]
71is less than
72.IR s2[i] .
c5880ed9 73.SH ATTRIBUTES
a13ca72f
PH
74For an explanation of the terms used in this section, see
75.BR attributes (7).
76.TS
77allbox;
78lb lb lb
79l l l.
80Interface Attribute Value
81T{
c5880ed9 82.BR wcsncmp ()
a13ca72f
PH
83T} Thread safety MT-Safe
84.TE
47297adb 85.SH CONFORMING TO
d6597cb0 86POSIX.1-2001, POSIX.1-2008, C99.
47297adb 87.SH SEE ALSO
fea681da
MK
88.BR strncmp (3),
89.BR wcsncasecmp (3)