lib/libc/locale/wcsxfrm.3

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