xref: /netbsd-src/lib/libc/locale/towctrans.3 (revision 0fd61eded95e792e9e54f70ecab7087601a8b052)
1*0fd61edeSwiz.\" $NetBSD: towctrans.3,v 1.6 2005/06/27 14:18:36 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 TOWCTRANS 3
29188f0525Stshiozak.Os
30188f0525Stshiozak.\" ----------------------------------------------------------------------
31188f0525Stshiozak.Sh NAME
32188f0525Stshiozak.Nm towctrans
33b4259105Swiz.Nd convert a wide character with a specified map
34188f0525Stshiozak.\" ----------------------------------------------------------------------
35188f0525Stshiozak.Sh LIBRARY
36188f0525Stshiozak.Lb libc
37188f0525Stshiozak.\" ----------------------------------------------------------------------
38188f0525Stshiozak.Sh SYNOPSIS
39472351e1Swiz.In wctype.h
40188f0525Stshiozak.Ft wint_t
41188f0525Stshiozak.Fn towctrans "wint_t wc" "wctrans_t charmap"
42188f0525Stshiozak.\" ----------------------------------------------------------------------
43188f0525Stshiozak.Sh DESCRIPTION
44188f0525StshiozakThe
45188f0525Stshiozak.Fn towctrans
46188f0525Stshiozakfunction converts a wide character
47188f0525Stshiozak.Fa wc
48188f0525Stshiozakwith a character mapping
49188f0525Stshiozak.Fa charmap .
50188f0525Stshiozak.Pp
51cef0afe9SwizThe behaviour of
52188f0525Stshiozak.Fn towctrans
53b4259105Swizis undefined if the
54188f0525Stshiozak.Fn towctrans
55188f0525Stshiozakfunction is called with an invalid
56188f0525Stshiozak.Fa charmap
57b4259105Swiz(changes of
58b4259105Swiz.Dv LC_CTYPE
59b4259105Swizcategory invalidate
60*0fd61edeSwiz.Fa charmap )
61b4259105Swizor invalid wide character
62188f0525Stshiozak.Fa wc .
63188f0525Stshiozak.Pp
64cef0afe9SwizThe behaviour of
65188f0525Stshiozak.Fn towctrans
66b4259105Swizis affected by the
67b4259105Swiz.Dv LC_CTYPE
68b4259105Swizcategory of the current locale.
69188f0525Stshiozak.\" ----------------------------------------------------------------------
70188f0525Stshiozak.Sh RETURN VALUES
71188f0525Stshiozak.Fn towctrans
72cef0afe9Swizreturns the resulting character of the conversion.
73188f0525Stshiozak.\" ----------------------------------------------------------------------
74188f0525Stshiozak.Sh ERRORS
75188f0525StshiozakNo errors are defined.
76188f0525Stshiozak.\" ----------------------------------------------------------------------
77188f0525Stshiozak.Sh SEE ALSO
78188f0525Stshiozak.Xr iswctype 3 ,
79b4259105Swiz.Xr setlocale 3 ,
80b4259105Swiz.Xr wctrans 3 ,
81b4259105Swiz.Xr wctype 3
82188f0525Stshiozak.\" ----------------------------------------------------------------------
83188f0525Stshiozak.Sh STANDARDS
84188f0525StshiozakThe
85188f0525Stshiozak.Fn towctrans
86188f0525Stshiozakfunction conforms to
87188f0525Stshiozak.St -isoC-amd1 .
88