bc469a927bd288d0360b917a6da5eb4cd1c9b17c
[dragonfly.git] / 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. 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.11.2.3 2001/12/14 18:33:59 ru Exp $
38 .\" $DragonFly: src/lib/libc/string/strxfrm.3,v 1.2 2003/06/17 04:26:47 dillon Exp $
39 .\"
40 .Dd June 4, 1993
41 .Dt STRXFRM 3
42 .Os
43 .Sh NAME
44 .Nm strxfrm
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 .Fn strxfrm "char *dst" "const char *src" "size_t n"
52 .Sh DESCRIPTION
53 The
54 .Fn strxfrm
55 function transforms a null-terminated string pointed to by
56 .Fa src
57 according to the current locale collation if any,
58 then copies the transformed string
59 into
60 .Fa dst .
61 Not more than
62 .Fa n
63 characters are copied into
64 .Fa dst ,
65 including the terminating null character added.
66 If
67 .Fa n
68 is set to 0
69 (it helps to determine an actual size needed
70 for transformation),
71 .Fa dst
72 is permitted to be a NULL pointer.
73 .Pp
74 Comparing two strings using
75 .Fn strcmp
76 after
77 .Fn strxfrm
78 is equal to comparing
79 two original strings with
80 .Fn strcoll .
81 .Sh RETURN VALUES
82 Upon successful completion,
83 .Fn strxfrm
84 returns the length of the transformed string not including
85 the terminating null 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 strcmp 3 ,
94 .Xr strcoll 3
95 .Sh STANDARDS
96 The
97 .Fn strxfrm
98 function
99 conforms to
100 .St -isoC .