summaryrefslogtreecommitdiffstats
path: root/man3/wcsncmp.3
diff options
context:
space:
mode:
Diffstat (limited to 'man3/wcsncmp.3')
-rw-r--r--man3/wcsncmp.341
1 files changed, 41 insertions, 0 deletions
diff --git a/man3/wcsncmp.3 b/man3/wcsncmp.3
new file mode 100644
index 000000000..75a10d137
--- /dev/null
+++ b/man3/wcsncmp.3
@@ -0,0 +1,41 @@
+.\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
+.\"
+.\" This is free documentation; you can redistribute it and/or
+.\" modify it under the terms of the GNU General Public License as
+.\" published by the Free Software Foundation; either version 2 of
+.\" the License, or (at your option) any later version.
+.\"
+.\" 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 1999-07-25 "GNU" "Linux Programmer's Manual"
+.SH NAME
+wcsncmp \- compare two fixed-size wide-character strings
+.SH SYNOPSIS
+.nf
+.B #include <wchar.h>
+.sp
+.BI "int wcsncmp(const wchar_t *" s1 ", const wchar_t *" s2 ", size_t " n );
+.fi
+.SH DESCRIPTION
+The \fBwcsncmp\fP function is the wide-character equivalent of the \fBstrncmp\fP
+function. It compares the wide-character string pointed to by \fIs1\fP and the
+wide-character string pointed to by \fIs2\fP, but at most \fIn\fP wide
+characters from each string. In each string, the comparison extends only up
+to the first occurrence of a L'\\0' character, if any.
+.SH "RETURN VALUE"
+The \fBwcsncmp\fP function returns zero if the wide-character strings at
+\fIs1\fP and \fIs2\fP, truncated to at most length \fIn\fP, are equal.
+It returns an integer greater than zero if at the first differing position
+\fIi\fP (\fIi\fP < \fIn\fP), the corresponding wide-character \fIs1[i]\fP is
+greater than \fIs2[i]\fP. It returns an integer less than zero if at the first
+differing position \fIi\fP (\fIi\fP < \fIn\fP), the corresponding
+wide-character \fIs1[i]\fP is less than \fIs2[i]\fP.
+.SH "CONFORMING TO"
+ISO/ANSI C, UNIX98
+.SH "SEE ALSO"
+.BR strncmp (3),
+.BR wcsncasecmp (3)