Sync lib/libc/string with FreeBSD:
[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 .\" 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 .\" $DragonFly: src/lib/libc/string/strxfrm.3,v 1.2 2003/06/17 04:26:47 dillon Exp $
35 .\"
36 .Dd June 4, 1993
37 .Dt STRXFRM 3
38 .Os
39 .Sh NAME
40 .Nm strxfrm
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 .Fn strxfrm "char * restrict dst" "const char * restrict src" "size_t n"
48 .Sh DESCRIPTION
49 The
50 .Fn strxfrm
51 function transforms a null-terminated string pointed to by
52 .Fa src
53 according to the current locale collation if any,
54 then copies the transformed string
55 into
56 .Fa dst .
57 Not more than
58 .Fa n
59 characters are copied into
60 .Fa dst ,
61 including the terminating null character added.
62 If
63 .Fa n
64 is set to 0
65 (it helps to determine an actual size needed
66 for transformation),
67 .Fa dst
68 is permitted to be a NULL pointer.
69 .Pp
70 Comparing two strings using
71 .Fn strcmp
72 after
73 .Fn strxfrm
74 is equal to comparing
75 two original strings with
76 .Fn strcoll .
77 .Sh RETURN VALUES
78 Upon successful completion,
79 .Fn strxfrm
80 returns the length of the transformed string not including
81 the terminating null character.
82 If this value is
83 .Fa n
84 or more, the contents of
85 .Fa dst
86 are indeterminate.
87 .Sh SEE ALSO
88 .Xr setlocale 3 ,
89 .Xr strcmp 3 ,
90 .Xr strcoll 3 ,
91 .Xr wcsxfrm 3
92 .Sh STANDARDS
93 The
94 .Fn strxfrm
95 function
96 conforms to
97 .St -isoC .