1.\" $NetBSD: towctrans.3,v 1.6 2005/06/27 14:18:36 wiz Exp $ 2.\" 3.\" Copyright (c)2003 Citrus Project, 4.\" All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 19.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25.\" SUCH DAMAGE. 26.\" 27.Dd March 4, 2003 28.Dt TOWCTRANS 3 29.Os 30.\" ---------------------------------------------------------------------- 31.Sh NAME 32.Nm towctrans 33.Nd convert a wide character with a specified map 34.\" ---------------------------------------------------------------------- 35.Sh LIBRARY 36.Lb libc 37.\" ---------------------------------------------------------------------- 38.Sh SYNOPSIS 39.In wctype.h 40.Ft wint_t 41.Fn towctrans "wint_t wc" "wctrans_t charmap" 42.\" ---------------------------------------------------------------------- 43.Sh DESCRIPTION 44The 45.Fn towctrans 46function converts a wide character 47.Fa wc 48with a character mapping 49.Fa charmap . 50.Pp 51The behaviour of 52.Fn towctrans 53is undefined if the 54.Fn towctrans 55function is called with an invalid 56.Fa charmap 57(changes of 58.Dv LC_CTYPE 59category invalidate 60.Fa charmap ) 61or invalid wide character 62.Fa wc . 63.Pp 64The behaviour of 65.Fn towctrans 66is affected by the 67.Dv LC_CTYPE 68category of the current locale. 69.\" ---------------------------------------------------------------------- 70.Sh RETURN VALUES 71.Fn towctrans 72returns the resulting character of the conversion. 73.\" ---------------------------------------------------------------------- 74.Sh ERRORS 75No errors are defined. 76.\" ---------------------------------------------------------------------- 77.Sh SEE ALSO 78.Xr iswctype 3 , 79.Xr setlocale 3 , 80.Xr wctrans 3 , 81.Xr wctype 3 82.\" ---------------------------------------------------------------------- 83.Sh STANDARDS 84The 85.Fn towctrans 86function conforms to 87.St -isoC-amd1 . 88