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