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