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