man-pages/man3/wcscmp.3

70 lines
1.6 KiB
Groff

.\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
.\"
.\" %%%LICENSE_START(GPLv2+_DOC_ONEPARA)
.\" 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.
.\" %%%LICENSE_END
.\"
.\" 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 WCSCMP 3 2013-12-02 "GNU" "Linux Programmer's Manual"
.SH NAME
wcscmp \- compare two wide-character strings
.SH SYNOPSIS
.nf
.B #include <wchar.h>
.sp
.BI "int wcscmp(const wchar_t *" s1 ", const wchar_t *" s2 );
.fi
.SH DESCRIPTION
The
.BR wcscmp ()
function is the wide-character equivalent
of the
.BR strcmp (3)
function.
It compares the wide-character string pointed to by
.I s1
and the
wide-character string pointed to by
.IR s2 .
.SH RETURN VALUE
The
.BR wcscmp ()
function returns zero if the wide-character strings at
.I s1
and
.I s2
are equal.
It returns an integer greater than zero if
at the first differing position
.IR i ,
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
.IR i ,
the corresponding wide-character
.I s1[i]
is less than
.IR s2[i] .
.SH ATTRIBUTES
.SS Multithreading (see pthreads(7))
The
.BR wcscmp ()
function is thread-safe.
.SH CONFORMING TO
C99.
.SH SEE ALSO
.BR strcmp (3),
.BR wcscasecmp (3),
.BR wmemcmp (3)