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. 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$ 34.\" 35.Dd June 4, 1993 36.Dt STRXFRM 3 37.Os 38.Sh NAME 39.Nm strxfrm 40.Nd transform a string under locale 41.Sh LIBRARY 42.Lb libc 43.Sh SYNOPSIS 44.In string.h 45.Ft size_t 46.Fn strxfrm "char * restrict dst" "const char * restrict src" "size_t n" 47.Ft size_t 48.Fn strxfrm_l "char * restrict dst" "const char *restrict src" "size_t n" "locale_t loc" 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.Pp 79.Fn strxfrm_l 80does the same, however takes an explicit locale rather than the global 81locale. 82.Sh RETURN VALUES 83Upon successful completion, 84.Fn strxfrm 85and 86.Fn strxfrm_l 87return the length of the transformed string not including 88the terminating null character. 89If this value is 90.Fa n 91or more, the contents of 92.Fa dst 93are indeterminate. 94.Sh SEE ALSO 95.Xr setlocale 3 , 96.Xr strcmp 3 , 97.Xr strcoll 3 , 98.Xr wcsxfrm 3 99.Sh STANDARDS 100The 101.Fn strxfrm 102function 103conforms to 104.St -isoC . 105The 106.Fn strxfrm_l 107function conforms to 108.St -p1003.1-2008 . 109