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 SYNOPSIS 46.Fd #include <string.h> 47.Ft size_t 48.Fn strxfrm "char *dst" "const char *src" "size_t n" 49.Sh DESCRIPTION 50The 51.Fn strxfrm 52function transforms a null-terminated string pointed to by 53.Fa src 54according to the current locale collation if any, 55then copies the transformed string 56into 57.Fa dst . 58Not more than 59.Fa n 60characters are copied into 61.Fa dst , 62including the terminating null character added. 63If 64.Fa n 65is set to 0 66(it helps to determine an actual size needed 67for transformation), 68.Fa dst 69is permitted to be a NULL pointer. 70.Pp 71Comparing two strings using 72.Fn strcmp 73after 74.Fn strxfrm 75is equal to comparing 76two original strings with 77.Fn strcoll . 78.Sh RETURN VALUES 79Upon successful completion, 80.Fn strxfrm 81returns the length of the transformed string not including 82the terminating null character. If this value is 83.Fa n 84or more, the contents of 85.Fa dst 86are indeterminate. 87.Sh SEE ALSO 88.Xr setlocale 3 , 89.Xr strcmp 3 , 90.Xr strcoll 3 91.Sh STANDARDS 92The 93.Fn strxfrm 94function 95conforms to 96.St -ansiC . 97