]> git.ipfire.org Git - thirdparty/man-pages.git/blame - man3/wcscmp.3
Import of man-pages 1.70
[thirdparty/man-pages.git] / man3 / wcscmp.3
CommitLineData
fea681da
MK
1.\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
2.\"
3.\" This is free documentation; you can redistribute it and/or
4.\" modify it under the terms of the GNU General Public License as
5.\" published by the Free Software Foundation; either version 2 of
6.\" the License, or (at your option) any later version.
7.\"
8.\" References consulted:
9.\" GNU glibc-2 source code and manual
10.\" Dinkumware C library reference http://www.dinkumware.com/
11.\" OpenGroup's Single Unix specification http://www.UNIX-systems.org/online.html
12.\" ISO/IEC 9899:1999
13.\"
14.TH WCSCMP 3 1999-07-25 "GNU" "Linux Programmer's Manual"
15.SH NAME
16wcscmp \- compare two wide-character strings
17.SH SYNOPSIS
18.nf
19.B #include <wchar.h>
20.sp
21.BI "int wcscmp(const wchar_t *" s1 ", const wchar_t *" s2 );
22.fi
23.SH DESCRIPTION
24The \fBwcscmp\fP function is the wide-character equivalent of the \fBstrcmp\fP
25function. It compares the wide-character string pointed to by \fIs1\fP and the
26wide-character string pointed to by \fIs2\fP.
27.SH "RETURN VALUE"
28The \fBwcscmp\fP function returns zero if the wide-character strings at
29\fIs1\fP and \fIs2\fP are equal. It returns an integer greater than zero if
30at the first differing position \fIi\fP, the corresponding wide-character
31\fIs1[i]\fP is greater than \fIs2[i]\fP. It returns an integer less than zero if
32at the first differing position \fIi\fP, the corresponding wide-character
33\fIs1[i]\fP is less than \fIs2[i]\fP.
34.SH "CONFORMING TO"
35ISO/ANSI C, UNIX98
36.SH "SEE ALSO"
37.BR strcmp (3),
38.BR wcscasecmp (3),
39.BR wmemcmp (3)