summaryrefslogtreecommitdiffstats
path: root/man3/wcsncmp.3
diff options
context:
space:
mode:
Diffstat (limited to 'man3/wcsncmp.3')
-rw-r--r--man3/wcsncmp.394
1 files changed, 94 insertions, 0 deletions
diff --git a/man3/wcsncmp.3 b/man3/wcsncmp.3
new file mode 100644
index 0000000..8e53bf2
--- /dev/null
+++ b/man3/wcsncmp.3
@@ -0,0 +1,94 @@
+'\" 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
+.\" ISO/IEC 9899:1999
+.\"
+.TH wcsncmp 3 2023-07-20 "Linux man-pages 6.05.01"
+.SH NAME
+wcsncmp \- compare two fixed-size wide-character strings
+.SH LIBRARY
+Standard C library
+.RI ( libc ", " \-lc )
+.SH SYNOPSIS
+.nf
+.B #include <wchar.h>
+.PP
+.BI "int wcsncmp(const wchar_t " s1 [. n "], const wchar_t " s2 [. n "], \
+size_t " n );
+.fi
+.SH DESCRIPTION
+The
+.BR wcsncmp ()
+function is the wide-character equivalent of the
+.BR strncmp (3)
+function.
+It compares the wide-character string pointed to by
+.I s1
+and the
+wide-character string pointed to by
+.IR s2 ,
+but at most
+.I n
+wide
+characters from each string.
+In each string, the comparison extends only up
+to the first occurrence of a null wide character (L\[aq]\e0\[aq]), if any.
+.SH RETURN VALUE
+The
+.BR wcsncmp ()
+function returns zero if the wide-character strings at
+.I s1
+and
+.IR s2 ,
+truncated to at most length
+.IR n ,
+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 wcsncmp ()
+T} Thread safety MT-Safe
+.TE
+.sp 1
+.SH STANDARDS
+C11, POSIX.1-2008.
+.SH HISTORY
+POSIX.1-2001, C99.
+.SH SEE ALSO
+.BR strncmp (3),
+.BR wcsncasecmp (3)