wcscoll(3C)                                                     wcscoll(3C)

NAME
     wcscoll - wide character string comparison collating information

SYNOPSIS
     #include <wchar.h>

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

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

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

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

     The wcscoll() function 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.

RESULT
     Upon successful completion, the wcscoll() function returns an integer
     greater than, equal to or less than zero, according to whether the
     wide character string pointed to by ws1 is greater than, equal or less
     than the wide character string pointed to by ws2, when both are inter-
     preted as appropriate to the current locale.

SEE ALSO
     wcscmp(3C), wcsxfrm(3C), wchar(5).

















Page 1                       Reliant UNIX 5.44                Printed 11/98