Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

strcoll(3c) [opensolaris man page]

strcoll(3C)						   Standard C Library Functions 					       strcoll(3C)

NAME
strcoll - string collation SYNOPSIS
#include <string.h> int strcoll(const char *s1, const char *s2); 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() 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 program's locale for 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() function may fail if: EINVAL The s1 or s2 arguments contain characters outside the domain of the collating sequence. FILES
/usr/lib/locale/locale/locale.so.* LC_COLLATE database for locale ATTRIBUTES
See attributes(5) for descriptions of the following attributes: +-----------------------------+-----------------------------+ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | +-----------------------------+-----------------------------+ |CSI |Enabled | +-----------------------------+-----------------------------+ |Interface Stability |Standard | +-----------------------------+-----------------------------+ |MT-Level |MT-Safe with exceptions | +-----------------------------+-----------------------------+ The strcoll() function can be used safely in multithreaded applications, as long as setlocale(3C) is not being called to change the locale. SEE ALSO
localedef(1), setlocale(3C), string(3C), strxfrm(3C), wsxfrm(3C), attributes(5), environ(5), standards(5) SunOS 5.11 1 Nov 2003 strcoll(3C)

Check Out this Related Man Page

SETLOCALE(3)						   BSD Library Functions Manual 					      SETLOCALE(3)

NAME
setlocale -- natural language formatting for C LIBRARY
Standard C Library (libc, -lc) SYNOPSIS
#include <locale.h> char * setlocale(int category, const char *locale); DESCRIPTION
The setlocale() function sets the C library's notion of natural language formatting style for particular sets of routines. Each such style is called a 'locale' and is invoked using an appropriate name passed as a C string. The setlocale() function recognizes several categories of routines. These are the categories and the sets of routines they select: LC_ALL Set the entire locale generically. LC_COLLATE Set a locale for string collation routines. This controls alphabetic ordering in strcoll() and strxfrm(). LC_CTYPE Set a locale for the ctype(3) and multibyte(3) functions. This controls recognition of upper and lower case, alphabetic or non- alphabetic characters, and so on. LC_MESSAGES Set a locale for message catalogs, see catopen(3) function. LC_MONETARY Set a locale for formatting monetary values; this affects the localeconv() function. LC_NUMERIC Set a locale for formatting numbers. This controls the formatting of decimal points in input and output of floating point num- bers in functions such as printf() and scanf(), as well as values returned by localeconv(). LC_TIME Set a locale for formatting dates and times using the strftime() function. Only three locales are defined by default, the empty string "" which denotes the native environment, and the "C" and "POSIX" locales, which denote the C language environment. A locale argument of NULL causes setlocale() to return the current locale. By default, C programs start in the "C" locale. The only function in the library that sets the locale is setlocale(); the locale is never changed as a side effect of some other routine. RETURN VALUES
Upon successful completion, setlocale() returns the string associated with the specified category for the requested locale. The setlocale() function returns NULL and fails to change the locale if the given combination of category and locale makes no sense. FILES
$PATH_LOCALE/locale/category /usr/share/locale/locale/category locale file for the locale locale and the category category. ERRORS
No errors are defined. SEE ALSO
colldef(1), mklocale(1), catopen(3), ctype(3), localeconv(3), multibyte(3), strcoll(3), strxfrm(3), euc(5), utf8(5), environ(7) STANDARDS
The setlocale() function conforms to ISO/IEC 9899:1999 (``ISO C99''). HISTORY
The setlocale() function first appeared in 4.4BSD. BSD
November 21, 2003 BSD
Man Page