lib/libc/locale/wcsxfrm.3

   1 .\" $NetBSD: wcsxfrm.3,v 1.2 2006/10/14 07:51:01 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 .\"     @(#)strxfrm.3   8.1 (Berkeley) 6/4/93
  39 .\" FreeBSD: src/lib/libc/string/strxfrm.3,v 1.16 2002/09/06 11:24:06 tjr Exp
  40 .\" FreeBSD: /repoman/r/ncvs/src/lib/libc/string/wcsxfrm.3,v 1.2 2002/12/09 14:04:05 ru Exp
  41 .\"
  42 .Dd October 13, 2006
  43 .Dt WCSXFRM 3
  44 .Os
  45 .Sh NAME
  46 .Nm wcsxfrm
  47 .Nd transform a wide string under locale
  48 .Sh LIBRARY
  49 .Lb libc
  50 .Sh SYNOPSIS
  51 .In wchar.h
  52 .Ft size_t
  53 .Fn wcsxfrm "wchar_t * restrict dst" "const wchar_t * restrict src" "size_t n"
  54 .Sh DESCRIPTION
  55 The
  56 .Fn wcsxfrm
  57 function transforms a nul-terminated wide character string pointed to by
  58 .Fa src
  59 according to the current locale collation order then copies the
  60 transformed string into
  61 .Fa dst .
  62 No more than
  63 .Fa n
  64 wide characters are copied into
  65 .Fa dst ,
  66 including the terminating nul character added.
  67 If
  68 .Fa n
  69 is set to 0
  70 (it helps to determine an actual size needed for transformation),
  71 .Fa dst
  72 is permitted to be a null pointer.
  73 .Pp
  74 Comparing two strings using
  75 .Fn wcscmp
  76 after
  77 .Fn wcsxfrm
  78 is equivalent to comparing two original strings with
  79 .Fn wcscoll .
  80 .Sh RETURN VALUES
  81 Upon successful completion,
  82 .Fn wcsxfrm
  83 returns the length of the transformed string not including
  84 the terminating nul character.
  85 If this value is
  86 .Fa n
  87 or more, the contents of
  88 .Fa dst
  89 are indeterminate.
  90 .Sh SEE ALSO
  91 .Xr setlocale 3 ,
  92 .Xr strxfrm 3 ,
  93 .Xr wcscmp 3 ,
  94 .Xr wcscoll 3
  95 .Sh STANDARDS
  96 The
  97 .Fn wcsxfrm
  98 function conforms to
  99 .St -isoC-99 .
 100 .Sh BUGS
 101 The current implementation of
 102 .Fn wcsxfrm
 103 function disregards
 104 .Dv LC_COLLATE
 105 locales, and falls back to using the
 106 .Fn wcsncpy
 107 function.