1WCSCOLL(3P)                POSIX Programmer's Manual               WCSCOLL(3P)
2
3
4

PROLOG

6       This  manual  page is part of the POSIX Programmer's Manual.  The Linux
7       implementation of this interface may differ (consult the  corresponding
8       Linux  manual page for details of Linux behavior), or the interface may
9       not be implemented on Linux.
10

NAME

12       wcscoll - wide-character string comparison using collating information
13

SYNOPSIS

15       #include <wchar.h>
16
17       int wcscoll(const wchar_t *ws1, const wchar_t *ws2);
18
19

DESCRIPTION

21       The wcscoll() function shall compare the wide-character string  pointed
22       to  by  ws1 to the wide-character string pointed to by ws2, both inter‐
23       preted as appropriate to the LC_COLLATE category of the current locale.
24
25       The wcscoll() function shall not change the setting of  errno  if  suc‐
26       cessful.
27
28       An  application  wishing to check for error situations should set errno
29       to 0 before calling wcscoll(). If errno is non-zero on return, an error
30       has occurred.
31

RETURN VALUE

33       Upon  successful  completion, wcscoll() shall return an integer greater
34       than, equal to, or less than 0, according to whether the wide-character
35       string  pointed  to  by ws1 is greater than, equal to, or less than the
36       wide-character string pointed to by ws2, when both are  interpreted  as
37       appropriate  to  the  current  locale.   On  error, wcscoll() shall set
38       errno, but no return value is reserved to indicate an error.
39

ERRORS

41       The wcscoll() function may fail if:
42
43       EINVAL The ws1 or ws2 arguments contain  wide-character  codes  outside
44              the domain of the collating sequence.
45
46
47       The following sections are informative.
48

EXAMPLES

50       None.
51

APPLICATION USAGE

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

RATIONALE

57       None.
58

FUTURE DIRECTIONS

60       None.
61

SEE ALSO

63       wcscmp(),    wcsxfrm(),    the    Base    Definitions     volume     of
64       IEEE Std 1003.1-2001, <wchar.h>
65

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