illumos: manual page: strcoll.3c

STRCOLL(3C) Standard C Library Functions STRCOLL(3C)

NAME

strcoll, strcoll_l - string collation

SYNOPSIS

#include <string.h>

int strcoll(const char *s1, const char *s2);

int strcoll_l(const char *s1, const char *s2, locale_t loc);

DESCRIPTION

Both strcoll() and strxfrm(3C) provide for locale-specific string
sorting. strcoll() is intended for applications in which the number of
comparisons per string is small. When strings are to be compared a number
of times, strxfrm(3C) is a more appropriate function because the
transformation process occurs only once.

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

The strcoll() function does not change the setting of errno if
successful.

Since no return value is reserved to indicate an error, an application
wishing to check for error situations should set errno to 0, then call
strcoll(), then check errno.

RETURN VALUES

Upon successful completion, strcoll() returns an integer greater than,
equal to, or less than zero in direct correlation to whether string s1 is
greater than, equal to, or less than the string s2. The comparison is
based on strings interpreted as appropriate to the locale category
LC_COLLATE (see setlocale(3C)).

On error, strcoll() may set errno, but no return value is reserved to
indicate an error.

ERRORS

The strcoll() and strcoll_l() functions may fail if:

EINVAL
The s1 or s2 arguments contain characters outside the domain of
the collating sequence.

FILES

/usr/lib/locale/locale/LC_COLLATE/*
collation database for locale

ATTRIBUTES