Man Wcscoll en anglais
WCSCOLL(P)                 POSIX Programmer's Manual                WCSCOLL(P)



 

NAME


       wcscoll - wide-character string comparison using collating information

 

SYNOPSIS


       #include 

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


 

DESCRIPTION






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

       The wcscoll() function shall not change the setting of  errno  if  suc-
       cessful.

       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() shall return 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() shall 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.


       The following sections are informative.

 

EXAMPLES


       None.

 

APPLICATION USAGE


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

 

RATIONALE


       None.

 

FUTURE DIRECTIONS


       None.

 

SEE ALSO


       wcscmp()   ,   wcsxfrm()   ,   the   Base   Definitions    volume    of
       IEEE Std 1003.1-2001, 

 

COPYRIGHT


       Portions  of  this text are reprinted and reproduced in electronic form
       from IEEE Std 1003.1, 2003 Edition, Standard for Information Technology
       --  Portable  Operating  System  Interface (POSIX), The Open Group Base
       Specifications Issue 6, Copyright (C) 2001-2003  by  the  Institute  of
       Electrical  and  Electronics  Engineers, Inc and The Open Group. In the
       event of any discrepancy between this version and the original IEEE and
       The  Open Group Standard, the original IEEE and The Open Group Standard
       is the referee document. The original Standard can be  obtained  online
       at http://www.opengroup.org/unix/online.html .



IEEE/The Open Group                  2003                           WCSCOLL(P)