Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
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 sort-
       ing.  strcoll() is intended for applications in	which  the  number  of
       comparisons per string is small.	When strings are to be compared	a num-
       ber 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 success-
       ful.

       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  applica-
       tions,  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.10			  1 Nov	2003			   strcoll(3C)

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUES | ERRORS | FILES | ATTRIBUTES | SEE ALSO

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=strcoll&sektion=3c&manpath=SunOS+5.10>

home | help