NAME

wcscoll - wide-character string comparison using collating information

 SYNOPSIS

#include <wchar.h>

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

 DESCRIPTION

The wcscoll() function compares the wide-character string pointed to by ws1 to the wide-character string pointed to by ws2, both interpreted as appropriate to the LC_COLLATE category of the current locale.

The wcscoll() function will not change the setting of errno if successful.

An application wishing to check for error situations should set errno to 0 before calling wcscoll(). If errno is non-zero on return, an error has occurred.

 RETURN VALUE

Upon successful completion, wcscoll() returns an integer greater than, equal to or less than 0, according to whether the wide-character string pointed to by ws1 is greater than, equal to or less than the wide-character string pointed to by ws2, when both are interpreted as appropriate to the current locale. On error, wcscoll() may set errno, but no return value is reserved to indicate an error.

 ERRORS

The wcscoll() function may fail if:

[EINVAL]

The ws1 or ws2 arguments contain wide-character codes outside the domain of the collating sequence.

 EXAMPLES

None.

 APPLICATION USAGE

The wcsxfrm() and wcscmp() functions should be used for sorting large lists.

 FUTURE DIRECTIONS

None.

 SEE ALSO

wcscmp(), wcsxfrm(), <wchar.h>.

DERIVATION

Derived from the MSE working draft.