lib/libc/string/strxfrm.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 .\" 3. 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 .\"     from: @(#)strxfrm.3     8.1 (Berkeley) 6/4/93
  33 .\"     $NetBSD: strxfrm.3,v 1.10 2007/02/18 00:38:22 hubertf Exp $
  34 .\"
  35 .Dd February 18, 2007
  36 .Dt STRXFRM 3
  37 .Os
  38 .Sh NAME
  39 .Nm strxfrm
  40 .Nd transform a string under locale
  41 .Sh LIBRARY
  42 .Lb libc
  43 .Sh SYNOPSIS
  44 .In string.h
  45 .Ft size_t
  46 .Fn strxfrm "char * restrict dst" "const char * restrict src" "size_t n"
  47 .Sh DESCRIPTION
  48 The idea of
  49 .Fn strxfrm
  50 is to
  51 .Dq un-localize
  52 a string: the function transforms
  53 .Ar src ,
  54 storing the result in
  55 .Ar dst ,
  56 such that
  57 .Xr strcmp 3
  58 on transformed strings returns what
  59 .Xr strcoll 3
  60 on the original untransformed strings would return.
  61 .Sh SEE ALSO
  62 .Xr bcmp 3 ,
  63 .Xr memcmp 3 ,
  64 .\" .Xr setlocale 3 ,
  65 .Xr strcasecmp 3 ,
  66 .Xr strcmp 3 ,
  67 .Xr strcoll 3
  68 .Sh STANDARDS
  69 The
  70 .Fn strxfrm
  71 function
  72 conforms to
  73 .St -ansiC .
  74 .Sh BUGS
  75 Since locales are not fully implemented on
  76 .Nx ,
  77 .Fn strxfrm
  78 just returns a copy of the original string.