.\" $OpenBSD: wctrans.3,v 1.3 2017/09/05 03:16:13 schwarze Exp $
.\" $NetBSD: wctrans.3,v 1.4 2004/01/24 16:58:54 wiz Exp $
.\"
.\" Copyright (c) 2017 Ingo Schwarze <schwarze@openbsd.org>
.\" Copyright (c) 2003 Citrus Project
.\" All rights reserved.
.\"
.\" 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.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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: September 5 2017 $
.Dt WCTRANS 3
.Os
.Sh NAME
.Nm wctrans ,
.Nm wctrans_l
.Nd get a character mapping identifier by name
.Sh SYNOPSIS
.In wctype.h
.Ft wctrans_t
.Fn wctrans "const char *charmap"
.Ft wctrans_t
.Fn wctrans_l "const char *charmap" "locale_t locale"
.Sh DESCRIPTION
These functions return a character mapping identifier
corresponding to the locale-specific character mapping name
.Fa charmap .
This identifier can be used in the subsequent calls of
.Fn towctrans
or
.Fn towctrans_l ,
respectively.
.Pp
The following names are defined in all locales:
.Bd -literal -offset indent
tolower toupper
.Ed
.Pp
The function
.Fn wctrans_l
uses the specified
.Fa locale ,
whereas
.Fn wctrans
uses the thread-specific locale set with
.Xr uselocale 3 ,
falling back to the global locale set with
.Xr setlocale 3 .
.Sh RETURN VALUES
These functions return the character mapping identifier, or
.Po Vt wctrans_t Pc Ns 0
if
.Fa charmap
does not corresponding to a valid character mapping name.
.Sh SEE ALSO
.Xr newlocale 3 ,
.Xr setlocale 3 ,
.Xr towctrans 3 ,
.Xr towlower 3 ,
.Xr wctype 3
.Sh STANDARDS
The
.Fn wctrans
function conforms to
.St -isoC-amd1 ,
and
.Fn wctrans_l
to
.St -p1003.1-2008 .
.Sh HISTORY
The
.Fn wctrans
function has been available since
.Ox 3.8 ,
and
.Fn wctrans_l
since
.Ox 6.2 .