lib/libc/locale/wcscoll.3

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