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