string/FreeBSD/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: src/lib/libc/string/strxfrm.3,v 1.18 2007/01/09 00:28:12 imp Exp $
  34 .\"
  35 .Dd June 4, 1993
  36 .Dt STRXFRM 3
  37 .Os
  38 .Sh NAME
  39 .Nm strxfrm ,
  40 .Nm strxfrm_l
  41 .Nd transform a string under locale
  42 .Sh LIBRARY
  43 .Lb libc
  44 .Sh SYNOPSIS
  45 .In string.h
  46 .Ft size_t
  47 .Fo strxfrm
  48 .Fa "char *restrict s1"
  49 .Fa "const char *restrict s2"
  50 .Fa "size_t n"
  51 .Fc
  52 .In string.h
  53 .In xlocale.h
  54 .Ft size_t
  55 .Fo strxfrm_l
  56 .Fa "char *restrict s1"
  57 .Fa "const char *restrict s2"
  58 .Fa "size_t n"
  59 .Fa "locale_t loc"
  60 .Fc
  61 .Sh DESCRIPTION
  62 The
  63 .Fn strxfrm
  64 function transforms a null-terminated string pointed to by
  65 .Fa s2
  66 according to the current locale collation if any,
  67 then copies the transformed string
  68 into
  69 .Fa s1 .
  70 Not more than
  71 .Fa n
  72 characters are copied into
  73 .Fa s1 ,
  74 including the terminating null character added.
  75 If
  76 .Fa n
  77 is set to 0
  78 (it helps to determine an actual size needed
  79 for transformation),
  80 .Fa s1
  81 is permitted to be a NULL pointer.
  82 .Pp
  83 Comparing two strings using
  84 .Fn strcmp
  85 after
  86 .Fn strxfrm
  87 is equal to comparing
  88 two original strings with
  89 .Fn strcoll .
  90 .Pp
  91 Although the
  92 .Fn strxfrm
  93 function uses the current locale, the
  94 .Fn strxfrm_l
  95 function may be passed a locale directly. See
  96 .Xr xlocale 3
  97 for more information.
  98 .Sh RETURN VALUES
  99 Upon successful completion,
 100 .Fn strxfrm
 101 returns the length of the transformed string not including
 102 the terminating null character.
 103 If this value is
 104 .Fa n
 105 or more, the contents of
 106 .Fa s1
 107 are indeterminate.
 108 .Sh SEE ALSO
 109 .Xr setlocale 3 ,
 110 .Xr strcmp 3 ,
 111 .Xr strcoll 3 ,
 112 .Xr wcsxfrm 3 ,
 113 .Xr xlocale 3
 114 .Sh STANDARDS
 115 The
 116 .Fn strxfrm
 117 function
 118 conforms to
 119 .St -isoC .