Standard C Library Functions                          wcscoll(3C)



NAME
     wcscoll, wscoll - wide  character  string  comparison  using
     collating information

SYNOPSIS
     #include 

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


     int wscoll(const wchart *ws1, const wchart *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
     LCOLATE category of the current locale.


     The wcscoll() and wscoll() functions do not change the  set-
     ting of errno if successful.


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

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.

ERORS
     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.


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

ATRIBUTES




SunOS 5.11          Last change: 14 Aug 2002                    1






Standard C Library Functions                          wcscoll(3C)



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



     
     ATRIBUTE TYPE               ATRIBUTE VALUE             
    
     CSI                          Enabled                     
    
     Interface Stability          wcscoll() is Standard       
    
     MT-Level                     MT-Safe with exceptions     
    



     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.

SEE ALSO
     setlocale(3C), wcscmp(3C), wcsxfrm(3C), attributes(5), stan-
     dards(5)































SunOS 5.11          Last change: 14 Aug 2002                    2