1.\" $OpenBSD: strxfrm.3,v 1.12 2019/01/18 07:43:36 schwarze Exp $ 2.\" 3.\" Copyright (c) 1990, 1991 The Regents of the University of California. 4.\" Copyright (c) 2017 Ingo Schwarze <schwarze@openbsd.org> 5.\" All rights reserved. 6.\" 7.\" This code is derived from software contributed to Berkeley by 8.\" Chris Torek and the American National Standards Committee X3, 9.\" on Information Processing Systems. 10.\" 11.\" Redistribution and use in source and binary forms, with or without 12.\" modification, are permitted provided that the following conditions 13.\" are met: 14.\" 1. Redistributions of source code must retain the above copyright 15.\" notice, this list of conditions and the following disclaimer. 16.\" 2. Redistributions in binary form must reproduce the above copyright 17.\" notice, this list of conditions and the following disclaimer in the 18.\" documentation and/or other materials provided with the distribution. 19.\" 3. Neither the name of the University nor the names of its contributors 20.\" may be used to endorse or promote products derived from this software 21.\" without specific prior written permission. 22.\" 23.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 24.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 25.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 26.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 27.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 28.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 29.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 30.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 31.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 32.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 33.\" SUCH DAMAGE. 34.\" 35.Dd $Mdocdate: January 18 2019 $ 36.Dt STRXFRM 3 37.Os 38.Sh NAME 39.Nm strxfrm , 40.Nm strxfrm_l 41.Nd transform a string under locale 42.Sh SYNOPSIS 43.In string.h 44.Ft size_t 45.Fn strxfrm "char *dst" "const char *src" "size_t n" 46.Ft size_t 47.Fn strxfrm_l "char *dst" "const char *src" "size_t n" "locale_t locale" 48.Sh DESCRIPTION 49The idea of 50.Fn strxfrm 51and 52.Fn strxfrm_l 53is to 54.Dq un-localize 55a string: the functions transform 56.Ar src , 57storing the result in 58.Ar dst , 59such that 60.Xr strcmp 3 61on transformed strings returns what 62.Xr strcoll 3 63on the original untransformed strings would return. 64.Pp 65On 66.Ox , 67both have the same effect as 68.Xr strlcpy 3 , 69and the global locale, the thread-specific locale, and the 70.Fa locale 71argument are ignored. 72On other operating systems, the behaviour may depend on the 73.Dv LC_CTYPE 74and 75.Dv LC_COLLATE 76locale categories set with 77.Xr setlocale 3 , 78.Xr uselocale 3 , 79or 80.Xr newlocale 3 . 81.Sh SEE ALSO 82.Xr newlocale 3 , 83.Xr setlocale 3 , 84.Xr strcmp 3 , 85.Xr strcoll 3 , 86.Xr strlcpy 3 , 87.Xr wcsxfrm 3 88.Sh STANDARDS 89The 90.Fn strxfrm 91function conforms to 92.St -ansiC , 93and 94.Fn strxfrm_l 95to 96.St -p1003.1-2008 . 97.Sh HISTORY 98The 99.Fn strxfrm 100function has been available since 101.Bx 4.3 Reno , 102and 103.Fn strxfrm_l 104since 105.Ox 6.2 . 106