The Open Group Base Specifications Issue 6
IEEE Std 1003.1, 2004 Edition
Copyright © 2001-2004 The IEEE and The Open Group, All Rights reserved.

#### NAME

> wcscoll - wide-character string comparison using collating information

#### SYNOPSIS

> ``#include <wchar.h>
> int wcscoll(const wchar_t *`ws1`, const wchar_t *`ws2`);
> ``

#### DESCRIPTION

> [CX] The functionality described on this reference page is aligned with the ISO C standard. Any conflict between the requirements described here and the ISO C standard is unintentional. This volume of IEEE Std 1003.1-2001 defers to the ISO C standard.

> The wcscoll() function shall 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 category of the current locale.

> [CX] The wcscoll() function shall not change the setting of errno if successful.

> 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. [CX] On error, wcscoll() shall set errno, but no return value is reserved to indicate an error.

#### ERRORS

> The wcscoll() function may fail if:

> [EINVAL]
>   [CX] 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, <wchar.h>

#### CHANGE HISTORY

> First released in Issue 4. Derived from the MSE working draft.

#### Issue 5

> Moved from ENHANCED I18N to BASE and the [ENOSYS] error is removed.

> The DESCRIPTION is updated to indicate that errno is not changed if the function is successful.

End of informative text.

UNIX ® is a registered Trademark of The Open Group.
POSIX ® is a registered Trademark of The IEEE.
[ Main Index | XBD | XCU | XSH | XRAT ]