xref: /netbsd-src/lib/libc/locale/wctrans.3 (revision cef0afe940dedba57f5f0eb8f805f4f56ffe126b)
1*cef0afe9Swiz.\" $NetBSD: wctrans.3,v 1.4 2004/01/24 16:58:54 wiz Exp $
2188f0525Stshiozak.\"
3188f0525Stshiozak.\" Copyright (c)2003 Citrus Project,
4188f0525Stshiozak.\" All rights reserved.
5188f0525Stshiozak.\"
6188f0525Stshiozak.\" Redistribution and use in source and binary forms, with or without
7188f0525Stshiozak.\" modification, are permitted provided that the following conditions
8188f0525Stshiozak.\" are met:
9188f0525Stshiozak.\" 1. Redistributions of source code must retain the above copyright
10188f0525Stshiozak.\"    notice, this list of conditions and the following disclaimer.
11188f0525Stshiozak.\" 2. Redistributions in binary form must reproduce the above copyright
12188f0525Stshiozak.\"    notice, this list of conditions and the following disclaimer in the
13188f0525Stshiozak.\"    documentation and/or other materials provided with the distribution.
14188f0525Stshiozak.\"
15188f0525Stshiozak.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16188f0525Stshiozak.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17188f0525Stshiozak.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18188f0525Stshiozak.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19188f0525Stshiozak.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20188f0525Stshiozak.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21188f0525Stshiozak.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22188f0525Stshiozak.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23188f0525Stshiozak.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24188f0525Stshiozak.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25188f0525Stshiozak.\" SUCH DAMAGE.
26188f0525Stshiozak.\"
27188f0525Stshiozak.Dd March 4, 2003
28188f0525Stshiozak.Dt WCTRANS 3
29188f0525Stshiozak.Os
30188f0525Stshiozak.\" ----------------------------------------------------------------------
31188f0525Stshiozak.Sh NAME
32188f0525Stshiozak.Nm wctrans
33188f0525Stshiozak.Nd get character mapping identifier by name
34188f0525Stshiozak.\" ----------------------------------------------------------------------
35188f0525Stshiozak.Sh LIBRARY
36188f0525Stshiozak.Lb libc
37188f0525Stshiozak.\" ----------------------------------------------------------------------
38188f0525Stshiozak.Sh SYNOPSIS
39472351e1Swiz.In wctype.h
40188f0525Stshiozak.Ft wctrans_t
41188f0525Stshiozak.Fn wctrans "const char *charmap"
42188f0525Stshiozak.\" ----------------------------------------------------------------------
43188f0525Stshiozak.Sh DESCRIPTION
44188f0525StshiozakThe
45188f0525Stshiozak.Fn wctrans
46188f0525Stshiozakfunction returns a character mapping identifier corresponding to the
47b4259105Swizlocale-specific character mapping name
48188f0525Stshiozak.Fa charmap .
49188f0525StshiozakThis identifier can be used on the subsequent calls of
50188f0525Stshiozak.Fn towctrans .
51188f0525StshiozakThe following names are defined in all locales:
52188f0525Stshiozak.Bd -literal -offset indent
53188f0525Stshiozaktolower toupper
54188f0525Stshiozak.Ed
55188f0525Stshiozak.Pp
56*cef0afe9SwizThe behaviour of
57188f0525Stshiozak.Fn wctrans
58b4259105Swizis affected by the
59b4259105Swiz.Dv LC_CTYPE
60b4259105Swizcategory of the current locale.
61188f0525Stshiozak.\" ----------------------------------------------------------------------
62188f0525Stshiozak.Sh RETURN VALUES
63188f0525Stshiozak.Fn wctrans
64188f0525Stshiozakreturns:
65188f0525Stshiozak.Bl -tag -width 012345678901
66188f0525Stshiozak.It 0
67*cef0afe9SwizIf the string
68188f0525Stshiozak.Fa charmap
69188f0525Stshiozakdoes not corresponding to a valid character mapping name.
70188f0525Stshiozak.It non-zero
71*cef0afe9SwizA character mapping identifier corresponding to
72188f0525Stshiozak.Fa charmap .
73188f0525Stshiozak.El
74188f0525Stshiozak.Pp
75b4259105SwizNote: wctype_t is a scalar type, e.g., a pointer.
76188f0525Stshiozak.\" ----------------------------------------------------------------------
77188f0525Stshiozak.Sh ERRORS
78188f0525StshiozakNo errors are defined.
79188f0525Stshiozak.\" ----------------------------------------------------------------------
80188f0525Stshiozak.Sh SEE ALSO
81188f0525Stshiozak.Xr iswctype 3 ,
82b4259105Swiz.Xr setlocale 3 ,
83b4259105Swiz.Xr wctype 3
84188f0525Stshiozak.\" ----------------------------------------------------------------------
85188f0525Stshiozak.Sh STANDARDS
86188f0525StshiozakThe
87188f0525Stshiozak.Fn towctrans
88188f0525Stshiozakfunction conforms to
89188f0525Stshiozak.St -isoC-amd1 .
90