lib/libc/locale/wcscoll.3

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