wcscoll(3C)

NAME

     wcscoll, wscoll - wide  character  string  comparison  using
     collating information

SYNOPSIS

     #include <wchar.h>

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

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

DESCRIPTION

     The wcscoll() and  wscoll() functions compare the wide char-
     acter  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

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

USAGE

     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.

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

     The wcscoll() and wscoll() functions can be used  safely  in
     multithreaded  applications  as long as setlocale(3C) is not
     being called to change the locale.

ATTRIBUTES

     See attributes(5) for descriptions of the  following  attri-
     butes:

     ____________________________________________________________
    |       ATTRIBUTE TYPE        |       ATTRIBUTE VALUE       |
    | MT-Level                    | MT-Safe with exceptions     |
    | CSI                         | Enabled                     |
    |_____________________________|_____________________________|

SEE ALSO

     setlocale(3C), wcscmp(3C), wcsxfrm(3C), attributes(5)