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

NAME

6       wcscoll - wide-character string comparison using collating information
7

SYNOPSIS

9       #include <wchar.h>
10
11       int wcscoll(const wchar_t *ws1, const wchar_t *ws2);
12
13

DESCRIPTION

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

RETURN VALUE

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

ERRORS

35       The wcscoll() function may fail if:
36
37       EINVAL The  ws1  or  ws2 arguments contain wide-character codes outside
38              the domain of the collating sequence.
39
40
41       The following sections are informative.
42

EXAMPLES

44       None.
45

APPLICATION USAGE

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

RATIONALE

51       None.
52

FUTURE DIRECTIONS

54       None.
55

SEE ALSO

57       wcscmp()    ,    wcsxfrm()   ,   the   Base   Definitions   volume   of
58       IEEE Std 1003.1-2001, <wchar.h>
59

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