std::wcscmp

 

C++

Language

Standard library headers

Concepts

Utilities library

Strings library

Containers library

Algorithms library

Iterators library

Numerics library

Input/output library

Localizations library

Regular expressions library (C++11)

Atomic operations library (C++11)

Thread support library (C++11)

Filesystem library (C++17)

Technical Specifications

 

Strings library

Null-terminated strings

Byte strings

Multibyte strings

Wide strings

Classes

basic_string

basic_string_view (C++17)

char_traits

 

Null-terminated wide strings

Functions
Character manipulation
iswalnum iswalpha iswlower iswupper iswdigit iswxdigit iswblank (C++11) wctype iswctype	iswcntrl iswgraph iswspace iswprint iswpunct towlower towupper wctrans towctrans
Conversions to numeric formats
wcstolwcstoll wcstoulwcstoull	wcstofwcstodwcstold wcstoimaxwcstouimax (C++11)(C++11)
String manipulation
wcslen wcscpy wcsncpy wcscat wcsncat wcscmp wcscoll wcsncmp	wcsxfrm wcschr wcsrchr wcspbrk wcsspn wcscspn wcsstr wcstok
Array manipulation
wmemcpy
wmemmove
wmemcmp
wmemchr
wmemset

 

Defined in header <cwchar>
int wcscmp( const wchar_t* lhs, const wchar_t* rhs );

Compares two null-terminated wide strings lexicographically.

The sign of the result is the sign of the difference between the values of the first pair of wide characters that differ in the strings being compared.

The behavior is undefined if lhs or rhs are not pointers to null-terminated wide strings.

Parameters

lhs, rhs

-

pointers to the null-terminated wide strings to compare

Return value

Negative value if lhs appears before rhs in lexicographical order.

Zero if lhs and rhs compare equal.

Positive value if lhs appears after rhs in lexicographical order.

Notes

This function is not locale-sensitive, unlike std::wcscoll, and the order may not be meaningful when characters from different Unicode blocks are used together or when the order of code units does not match collation order.

Example

Run this code

#include <vector>
#include <cwchar>
#include <algorithm>
#include <iostream>
 
int main()
{
    std::vector<const wchar_t*> leaders{L"Ленин", L"Сталин", L"Маленков",
        L"Хрущёв", L"Брежнев", L"Андропов", L"Черненко", L"Горбачёв"};
 
    std::sort(leaders.begin(), leaders.end(), [](auto strA, auto strB) {
        return std::wcscmp(strA, strB) < 0;
    });
 
    std::setlocale(LC_ALL, "en_US.utf8");
    std::wcout.imbue(std::locale("en_US.utf8"));
    for (auto leader : leaders)
        std::wcout << leader << '\n';
}

Possible output:

Андропов
Брежнев
Горбачёв
Ленин
Маленков
Сталин
Хрущёв
Черненко

See also

wcsncmp	compares a certain amount of characters from two wide strings (function)
wmemcmp	compares a certain amount of wide characters from two arrays (function)
strcmp	compares two strings (function)
wcscoll	compares two wide strings in accordance to the current locale (function)
C documentation for wcscmp