1.\" $OpenBSD: wctrans.3,v 1.1 2005/07/01 08:59:27 espie Exp $
2.\"
3.\" $NetBSD: wctrans.3,v 1.4 2004/01/24 16:58:54 wiz Exp $
4.\"
5.\" Copyright (c)2003 Citrus Project,
6.\" All rights reserved.
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.\"
17.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27.\" SUCH DAMAGE.
28.\"
29.Dd March 4, 2003
30.Dt WCTRANS 3
31.Os
32.\" ----------------------------------------------------------------------
33.Sh NAME
34.Nm wctrans
35.Nd get character mapping identifier by name
36.\" ----------------------------------------------------------------------
37.Sh SYNOPSIS
38.In wctype.h
39.Ft wctrans_t
40.Fn wctrans "const char *charmap"
41.\" ----------------------------------------------------------------------
42.Sh DESCRIPTION
43The
44.Fn wctrans
45function returns a character mapping identifier corresponding to the
46locale-specific character mapping name
47.Fa charmap .
48This identifier can be used on the subsequent calls of
49.Fn towctrans .
50The following names are defined in all locales:
51.Bd -literal -offset indent
52tolower toupper
53.Ed
54.Pp
55The behaviour of
56.Fn wctrans
57is affected by the
58.Dv LC_CTYPE
59category of the current locale.
60.\" ----------------------------------------------------------------------
61.Sh RETURN VALUES
62.Fn wctrans
63returns:
64.Bl -tag -width 012345678901
65.It 0
66If the string
67.Fa charmap
68does not corresponding to a valid character mapping name.
69.It non-zero
70A character mapping identifier corresponding to
71.Fa charmap .
72.El
73.Pp
74Note: wctype_t is a scalar type, e.g., a pointer.
75.\" ----------------------------------------------------------------------
76.Sh ERRORS
77No errors are defined.
78.\" ----------------------------------------------------------------------
79.Sh SEE ALSO
80.Xr iswctype 3 ,
81.Xr setlocale 3 ,
82.Xr wctype 3
83.\" ----------------------------------------------------------------------
84.Sh STANDARDS
85The
86.Fn towctrans
87function conforms to
88.St -isoC-amd1 .
89