string/FreeBSD/wcscoll.3

   1 .\" Copyright (c) 1990, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" This code is derived from software contributed to Berkeley by
   5 .\" Chris Torek and the American National Standards Committee X3,
   6 .\" on Information Processing Systems.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)strcoll.3   8.1 (Berkeley) 6/4/93
  33 .\" FreeBSD: src/lib/libc/string/strcoll.3,v 1.11 2001/10/01 16:09:00 ru Exp
  34 .\" $FreeBSD: src/lib/libc/string/wcscoll.3,v 1.3 2007/01/09 00:28:12 imp Exp $
  35 .\"
  36 .Dd October 4, 2002
  37 .Dt WCSCOLL 3
  38 .Os
  39 .Sh NAME
  40 .Nm wcscoll ,
  41 .Nm wcscoll_l
  42 .Nd compare wide strings according to current collation
  43 .Sh LIBRARY
  44 .Lb libc
  45 .Sh SYNOPSIS
  46 .In wchar.h
  47 .Ft int
  48 .Fo wcscoll
  49 .Fa "const wchar_t *ws1"
  50 .Fa "const wchar_t *ws2"
  51 .Fc
  52 .In wchar.h
  53 .In xlocale.h
  54 .Ft int
  55 .Fo wcscoll_l
  56 .Fa "const wchar_t *ws1"
  57 .Fa "const wchar_t *ws2"
  58 .Fa "locale_t loc"
  59 .Fc
  60 .Sh DESCRIPTION
  61 The
  62 .Fn wcscoll
  63 function compares the null-terminated strings
  64 .Fa ws1
  65 and
  66 .Fa ws2 ,
  67 according to the current locale's collation order.
  68 In the
  69 .Dq Li C
  70 locale,
  71 .Fn wcscoll
  72 is equivalent to
  73 .Fn wcscmp .
  74 .Pp
  75 Although the
  76 .Fn wcscoll
  77 function uses the current locale, the
  78 .Fn wcscoll_l
  79 function may be passed a locale directly. See
  80 .Xr xlocale 3
  81 for more information.
  82 .Sh RETURN VALUES
  83 The
  84 .Fn wcscoll
  85 function
  86 returns an integer greater than, equal to, or less than 0,
  87 if
  88 .Fa ws1
  89 is greater than, equal to, or less than
  90 .Fa ws2 .
  91 .Pp
  92 No return value is reserved to indicate errors;
  93 callers should set
  94 .Va errno
  95 to 0 before calling
  96 .Fn wcscoll .
  97 If it is non-zero upon return from
  98 .Fn wcscoll ,
  99 an error has occurred.
 100 .Sh ERRORS
 101 The
 102 .Fn wcscoll
 103 function will fail if:
 104 .Bl -tag -width Er
 105 .It Bq Er EILSEQ
 106 An invalid wide character code was specified.
 107 .It Bq Er ENOMEM
 108 Cannot allocate enough memory for temporary buffers.
 109 .El
 110 .Sh SEE ALSO
 111 .Xr setlocale 3 ,
 112 .Xr strcoll 3 ,
 113 .Xr wcscmp 3 ,
 114 .Xr wcsxfrm 3 ,
 115 .Xr xlocale 3
 116 .Sh STANDARDS
 117 The
 118 .Fn wcscoll
 119 function
 120 conforms to
 121 .St -isoC-99 .
 122 .Sh BUGS
 123 The current implementation of
 124 .Fn wcscoll
 125 only works in single-byte
 126 .Dv LC_CTYPE
 127 locales, and falls back to using
 128 .Fn wcscmp
 129 in locales with extended character sets.