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. All advertising materials mentioning features or use of this software
  17 .\"    must display the following acknowledgement:
  18 .\"     This product includes software developed by the University of
  19 .\"     California, Berkeley and its contributors.
  20 .\" 4. Neither the name of the University nor the names of its contributors
  21 .\"    may be used to endorse or promote products derived from this software
  22 .\"    without specific prior written permission.
  23 .\"
  24 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34 .\" SUCH DAMAGE.
  35 .\"
  36 .\"     @(#)strxfrm.3   8.1 (Berkeley) 6/4/93
  37 .\" $FreeBSD: src/lib/libc/string/strxfrm.3,v 1.17 2002/10/15 10:11:53 tjr Exp $
  38 .\"
  39 .Dd June 4, 1993
  40 .Dt STRXFRM 3
  41 .Os
  42 .Sh NAME
  43 .Nm strxfrm ,
  44 .Nm strxfrm_l
  45 .Nd transform a string under locale
  46 .Sh LIBRARY
  47 .Lb libc
  48 .Sh SYNOPSIS
  49 .In string.h
  50 .Ft size_t
  51 .Fo strxfrm
  52 .Fa "char *restrict s1"
  53 .Fa "const char *restrict s2"
  54 .Fa "size_t n"
  55 .Fc
  56 .In string.h
  57 .In xlocale.h
  58 .Ft size_t
  59 .Fo strxfrm_l
  60 .Fa "char *restrict s1"
  61 .Fa "const char *restrict s2"
  62 .Fa "size_t n"
  63 .Fa "locale_t loc"
  64 .Fc
  65 .Sh DESCRIPTION
  66 The
  67 .Fn strxfrm
  68 function transforms a null-terminated string pointed to by
  69 .Fa s2
  70 according to the current locale collation if any,
  71 then copies the transformed string
  72 into
  73 .Fa s1 .
  74 Not more than
  75 .Fa n
  76 characters are copied into
  77 .Fa s1 ,
  78 including the terminating null character added.
  79 If
  80 .Fa n
  81 is set to 0
  82 (it helps to determine an actual size needed
  83 for transformation),
  84 .Fa s1
  85 is permitted to be a NULL pointer.
  86 .Pp
  87 Comparing two strings using
  88 .Fn strcmp
  89 after
  90 .Fn strxfrm
  91 is equal to comparing
  92 two original strings with
  93 .Fn strcoll .
  94 .Pp
  95 Although the
  96 .Fn strxfrm
  97 function uses the current locale, the
  98 .Fn strxfrm_l
  99 function may be passed a locale directly. See
 100 .Xr xlocale 3
 101 for more information.
 102 .Sh RETURN VALUES
 103 Upon successful completion,
 104 .Fn strxfrm
 105 returns the length of the transformed string not including
 106 the terminating null character.
 107 If this value is
 108 .Fa n
 109 or more, the contents of
 110 .Fa s1
 111 are indeterminate.
 112 .Sh SEE ALSO
 113 .Xr setlocale 3 ,
 114 .Xr strcmp 3 ,
 115 .Xr strcoll 3 ,
 116 .Xr wcsxfrm 3 ,
 117 .Xr xlocale 3
 118 .Sh STANDARDS
 119 The
 120 .Fn strxfrm
 121 function
 122 conforms to
 123 .St -isoC .