.\"	$OpenBSD: wcsxfrm.3,v 1.2 2019/01/18 07:43:36 schwarze Exp $
.\"
.\" Copyright (c) 1990, 1991 The Regents of the University of California.
.\" Copyright (c) 2017 Ingo Schwarze <schwarze@openbsd.org>
.\" All rights reserved.
.\"
.\" This code is derived from software contributed to Berkeley by
.\" Chris Torek and the American National Standards Committee X3,
.\" on Information Processing Systems.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.Dd $Mdocdate: January 18 2019 $
.Dt WCSXFRM 3
.Os
.Sh NAME
.Nm wcsxfrm ,
.Nm wcsxfrm_l
.Nd transform a wide string under locale
.Sh SYNOPSIS
.In wchar.h
.Ft size_t
.Fn wcsxfrm "wchar_t *dst" "const wchar_t *src" "size_t n"
.Ft size_t
.Fn wcsxfrm_l "wchar_t *dst" "const wchar_t *src" "size_t n" "locale_t locale"
.Sh DESCRIPTION
The idea of
.Fn wcsxfrm
and
.Fn wcsxfrm_l
is to
.Dq un-localize
a wide string: the functions transform
.Ar src ,
storing the result in
.Ar dst ,
such that
.Xr wcscmp 3
on transformed wide strings returns what
.Xr wcscoll 3
on the original untransformed wide strings would return.
.Pp
On
.Ox ,
both have the same effect as
.Xr wcslcpy 3 ,
and the global locale, the thread-specific locale, and the
.Fa locale
argument are ignored.
On other operating systems, the behaviour may depend on the
.Dv LC_CTYPE
and
.Dv LC_COLLATE
locale categories set with
.Xr setlocale 3 ,
.Xr uselocale 3 ,
or
.Xr newlocale 3 .
.Sh SEE ALSO
.Xr newlocale 3 ,
.Xr setlocale 3 ,
.Xr wcscmp 3 ,
.Xr wcscoll 3 ,
.Xr wcslcpy 3
.Sh STANDARDS
The
.Fn wcsxfrm
function conforms to
.St -isoC-99 ,
and
.Fn wcsxfrm_l
to
.St -p1003.1-2008 .
.Sh HISTORY
The
.Fn wcsxfrm
function has been available since
.Ox 4.8 ,
and
.Fn wcsxfrm_l
since
.Ox 6.2 .