Sun Microsystems, Inc. gratefully acknowledges The Open Group for
permission to reproduce portions of its copyrighted documentation.
Original documentation from The Open Group can be obtained online at
http://www.opengroup.org/bookstore/.

The Institute of Electrical and Electronics Engineers and The Open
Group, have given us permission to reprint portions of their
documentation.

In the following statement, the phrase ``this text'' refers to portions
of the system documentation.

Portions of this text are reprinted and reproduced in electronic form
in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
Standard for Information Technology -- Portable Operating System
Interface (POSIX), The Open Group Base Specifications Issue 6,
Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
Engineers, Inc and The Open Group. In the event of any discrepancy
between these versions 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.

This notice shall appear on any product containing this material.

The contents of this file are subject to the terms of the
Common Development and Distribution License (the "License").
You may not use this file except in compliance with the License.

You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
or http://www.opensolaris.org/os/licensing.
See the License for the specific language governing permissions
and limitations under the License.

When distributing Covered Code, include this CDDL HEADER in each
file and include the License file at usr/src/OPENSOLARIS.LICENSE.
If applicable, add the following below this CDDL HEADER, with the
fields enclosed by brackets "[]" replaced with your own identifying
information: Portions Copyright [yyyy] [name of copyright owner]


Copyright (c) 1992, X/Open Company Limited. All Rights Reserved.
Portions Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved
Copyright 2014 Garrett D'Amore <garrett@damore.org>

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

#include <wchar.h>

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

int wcscoll_l(const wchar_t *ws1, const wchar_t *ws2, locale_t loc);

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

The wcscoll(), wcscoll_l(), and wscoll() functions compare the wide character string pointed to by ws1 to the wide character string pointed to by ws2, both interpreted as appropriate to the LC_COLLATE locale category.

These functions do not change the setting of errno if successful.

An application wanting to check for error situations should set errno to 0 before calling these functions. If errno is non-zero on return, an error has occurred.

The function wcsoll_l() behaves identically to wcsoll(), except instead of operating in the current locale, it operates in the locale specified by loc.

Upon successful completion, these functions 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, or the locale specified by loc. On error, they set errno, but no return value is reserved to indicate an error.

The wcscoll(), wcscoll_l() and wscoll() functions may fail if: EINVAL

The wcsxfrm(3C) and wcscmp(3C) functions should be used for sorting large lists, or when performing many comparisons on the same strings.

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE

CSI Enabled

Interface Stability See below.

MT-Level MT-Safe

The wcscoll() and wcscoll_l() functions are Standard. The wscoll() function is Committed.

newlocale(3C), setlocale(3C), uselocale(3C), wcscmp(3C), wcsxfrm(3C), attributes(5), standards(5)