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 .Nd compare wide strings according to current collation
  42 .Sh LIBRARY
  43 .Lb libc
  44 .Sh SYNOPSIS
  45 .In wchar.h
  46 .Ft int
  47 .Fn wcscoll "const wchar_t *s1" "const wchar_t *s2"
  48 .Sh DESCRIPTION
  49 The
  50 .Fn wcscoll
  51 function compares the null-terminated strings
  52 .Fa s1
  53 and
  54 .Fa s2
  55 according to the current locale collation order.
  56 In the
  57 .Dq Li C
  58 locale,
  59 .Fn wcscoll
  60 is equivalent to
  61 .Fn wcscmp .
  62 .Sh RETURN VALUES
  63 The
  64 .Fn wcscoll
  65 function
  66 returns an integer greater than, equal to, or less than 0,
  67 if
  68 .Fa s1
  69 is greater than, equal to, or less than
  70 .Fa s2 .
  71 .Pp
  72 No return value is reserved to indicate errors;
  73 callers should set
  74 .Va errno
  75 to 0 before calling
  76 .Fn wcscoll .
  77 If it is non-zero upon return from
  78 .Fn wcscoll ,
  79 an error has occurred.
  80 .Sh ERRORS
  81 The
  82 .Fn wcscoll
  83 function will fail if:
  84 .Bl -tag -width Er
  85 .It Bq Er EILSEQ
  86 An invalid wide character code was specified.
  87 .It Bq Er ENOMEM
  88 Cannot allocate enough memory for temporary buffers.
  89 .El
  90 .Sh SEE ALSO
  91 .Xr setlocale 3 ,
  92 .Xr strcoll 3 ,
  93 .Xr wcscmp 3 ,
  94 .Xr wcsxfrm 3
  95 .Sh STANDARDS
  96 The
  97 .Fn wcscoll
  98 function
  99 conforms to
 100 .St -isoC-99 .
 101 .Sh BUGS
 102 The current implementation of
 103 .Fn wcscoll
 104 only works in single-byte
 105 .Dv LC_CTYPE
 106 locales, and falls back to using
 107 .Fn wcscmp
 108 in locales with extended character sets.