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