1.\" $NetBSD: wctrans.3,v 1.4 2004/01/24 16:58:54 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 WCTRANS 3 29.Os 30.\" ---------------------------------------------------------------------- 31.Sh NAME 32.Nm wctrans 33.Nd get character mapping identifier by name 34.\" ---------------------------------------------------------------------- 35.Sh LIBRARY 36.Lb libc 37.\" ---------------------------------------------------------------------- 38.Sh SYNOPSIS 39.In wctype.h 40.Ft wctrans_t 41.Fn wctrans "const char *charmap" 42.\" ---------------------------------------------------------------------- 43.Sh DESCRIPTION 44The 45.Fn wctrans 46function returns a character mapping identifier corresponding to the 47locale-specific character mapping name 48.Fa charmap . 49This identifier can be used on the subsequent calls of 50.Fn towctrans . 51The following names are defined in all locales: 52.Bd -literal -offset indent 53tolower toupper 54.Ed 55.Pp 56The behaviour of 57.Fn wctrans 58is affected by the 59.Dv LC_CTYPE 60category of the current locale. 61.\" ---------------------------------------------------------------------- 62.Sh RETURN VALUES 63.Fn wctrans 64returns: 65.Bl -tag -width 012345678901 66.It 0 67If the string 68.Fa charmap 69does not corresponding to a valid character mapping name. 70.It non-zero 71A character mapping identifier corresponding to 72.Fa charmap . 73.El 74.Pp 75Note: wctype_t is a scalar type, e.g., a pointer. 76.\" ---------------------------------------------------------------------- 77.Sh ERRORS 78No errors are defined. 79.\" ---------------------------------------------------------------------- 80.Sh SEE ALSO 81.Xr iswctype 3 , 82.Xr setlocale 3 , 83.Xr wctype 3 84.\" ---------------------------------------------------------------------- 85.Sh STANDARDS 86The 87.Fn towctrans 88function conforms to 89.St -isoC-amd1 . 90