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 .\" 4. 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 .\"     @(#)strxfrm.3   8.1 (Berkeley) 6/4/93
  33 .\" $FreeBSD$
  34 .\"
  35 .Dd June 4, 1993
  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
  49 .Fn strxfrm
  50 function transforms a null-terminated string pointed to by
  51 .Fa src
  52 according to the current locale collation if any,
  53 then copies the transformed string
  54 into
  55 .Fa dst .
  56 Not more than
  57 .Fa n
  58 characters are copied into
  59 .Fa dst ,
  60 including the terminating null character added.
  61 If
  62 .Fa n
  63 is set to 0
  64 (it helps to determine an actual size needed
  65 for transformation),
  66 .Fa dst
  67 is permitted to be a NULL pointer.
  68 .Pp
  69 Comparing two strings using
  70 .Fn strcmp
  71 after
  72 .Fn strxfrm
  73 is equal to comparing
  74 two original strings with
  75 .Fn strcoll .
  76 .Sh RETURN VALUES
  77 Upon successful completion,
  78 .Fn strxfrm
  79 returns the length of the transformed string not including
  80 the terminating null character.
  81 If this value is
  82 .Fa n
  83 or more, the contents of
  84 .Fa dst
  85 are indeterminate.
  86 .Sh SEE ALSO
  87 .Xr setlocale 3 ,
  88 .Xr strcmp 3 ,
  89 .Xr strcoll 3 ,
  90 .Xr wcsxfrm 3
  91 .Sh STANDARDS
  92 The
  93 .Fn strxfrm
  94 function
  95 conforms to
  96 .St -isoC .