[Go to CFHT Home Page] Man Pages
Back to Software Index  BORDER=0Manpage Top Level
    wcscoll(3I) manual page Table of Contents

Name

wcscoll, wscoll - wide character string comparison using collating information

Synopsis

cc [ flag ... ] file ... -lw [ library ... ]

#include <wchar.h>

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

MT-Level

MT-Safe

Description

The wcscoll() and wscoll() functions compare 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.

Return Values

Upon successful completion, wcscoll() and wscoll() return an integer greater than, equal to, or less than 0, depending upon 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() and wscoll() may set errno, but no return value is reserved to indicate an error.

Errors

wcscoll() and wscoll() may fail if:
EINVAL
The ws1 or ws2 arguments contain wide character codes outside the domain of the collating sequence.
ENOSYS
The function is not supported.

See Also

setlocale(3C) , wcscmp(3I) , wcsxfrm(3I)

Notes

Because no return value is reserved to indicate an error, an application wishing to check for error situations should set errno to 0, call either wcscoll() or wscoll(), then check errno and if it is non-zero, assume an error has occurred.

wcsxfrm(3I) and wcscmp(3I) should be used for sorting large lists. ~

Table of Contents