wcscmp - Man Page

compare two wide-character strings

Prolog

This manual page is part of the POSIX Programmer's Manual. The Linux implementation of this interface may differ (consult the corresponding Linux manual page for details of Linux behavior), or the interface may not be implemented on Linux.

Synopsis

#include <wchar.h>

int wcscmp(const wchar_t *ws1, const wchar_t *ws2);

Description

The functionality described on this reference page is aligned with the ISO C standard. Any conflict between the requirements described here and the ISO C standard is unintentional. This volume of POSIX.1-2017 defers to the ISO C standard.

The wcscmp() function shall compare the wide-character string pointed to by ws1 to the wide-character string pointed to by ws2.

The sign of a non-zero return value shall be determined by the sign of the difference between the values of the first pair of wide-character codes that differ in the objects being compared.

Return Value

Upon completion, wcscmp() shall return an integer greater than, equal to, or less than 0, if the wide-character string pointed to by ws1 is greater than, equal to, or less than the wide-character string pointed to by ws2, respectively.

Errors

No errors are defined.

The following sections are informative.

Examples

None.

Application Usage

None.

Rationale

None.

Future Directions

None.

See Also

wcscasecmp(), wcsncmp()

The Base Definitions volume of POSIX.1-2017, <wchar.h>

Referenced By

wchar.h(0p), wcscasecmp(3p), wcscoll(3p), wcsncmp(3p), wcsxfrm(3p).

2017 IEEE/The Open Group POSIX Programmer's Manual