90 lines
3.1 KiB
Groff
90 lines
3.1 KiB
Groff
|
.\" $NetBSD: wctrans.3,v 1.1 2003/03/04 12:11:52 tshiozak Exp $
|
||
|
|
.\"
|
||
|
|
.\" Copyright (c)2003 Citrus Project,
|
||
|
|
.\" All rights reserved.
|
||
|
|
.\"
|
||
|
|
.\" Redistribution and use in source and binary forms, with or without
|
||
|
|
.\" modification, are permitted provided that the following conditions
|
||
|
|
.\" are met:
|
||
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
||
|
|
.\" notice, this list of conditions and the following disclaimer.
|
||
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
||
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
||
|
|
.\" documentation and/or other materials provided with the distribution.
|
||
|
|
.\"
|
||
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
||
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
||
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
||
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
||
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
||
|
|
.\" SUCH DAMAGE.
|
||
|
|
.\"
|
||
|
|
.Dd March 4, 2003
|
||
|
|
.Dt WCTRANS 3
|
||
|
|
.Os
|
||
|
|
.\" ----------------------------------------------------------------------
|
||
|
|
.Sh NAME
|
||
|
|
.Nm wctrans
|
||
|
|
.Nd get character mapping identifier by name
|
||
|
|
.\" ----------------------------------------------------------------------
|
||
|
|
.Sh LIBRARY
|
||
|
|
.Lb libc
|
||
|
|
.\" ----------------------------------------------------------------------
|
||
|
|
.Sh SYNOPSIS
|
||
|
|
.Fd #include \*[Lt]wctype.h\*[Gt]
|
||
|
|
.Ft wctrans_t
|
||
|
|
.Fn wctrans "const char *charmap"
|
||
|
|
.\" ----------------------------------------------------------------------
|
||
|
|
.Sh DESCRIPTION
|
||
|
|
The
|
||
|
|
.Fn wctrans
|
||
|
|
function returns a character mapping identifier corresponding to the
|
||
|
|
locale-specific character mapping name, pointed by
|
||
|
|
.Fa charmap .
|
||
|
|
This identifier can be used on the subsequent calls of
|
||
|
|
.Fn towctrans .
|
||
|
|
The following names are defined in all locales:
|
||
|
|
.Bd -literal -offset indent
|
||
|
|
tolower toupper
|
||
|
|
.Ed
|
||
|
|
.Pp
|
||
|
|
The behaviour of the
|
||
|
|
.Fn wctrans
|
||
|
|
is affected by LC_CTYPE category of the current locale.
|
||
|
|
.\" ----------------------------------------------------------------------
|
||
|
|
.Sh RETURN VALUES
|
||
|
|
The
|
||
|
|
.Fn wctrans
|
||
|
|
returns:
|
||
|
|
.Bl -tag -width 012345678901
|
||
|
|
.It 0
|
||
|
|
if the string pointed by
|
||
|
|
.Fa charmap
|
||
|
|
does not corresponding to a valid character mapping name.
|
||
|
|
.It non-zero
|
||
|
|
an character mapping identifier corresponding to the name pointed by
|
||
|
|
.Fa charmap .
|
||
|
|
.El
|
||
|
|
.Pp
|
||
|
|
note: wctype_t is a scalar type, e.g. pointer.
|
||
|
|
.\" ----------------------------------------------------------------------
|
||
|
|
.Sh ERRORS
|
||
|
|
No errors are defined.
|
||
|
|
.\" ----------------------------------------------------------------------
|
||
|
|
.Sh SEE ALSO
|
||
|
|
.Xr wctrans 3 ,
|
||
|
|
.Xr wctype 3 ,
|
||
|
|
.Xr iswctype 3 ,
|
||
|
|
.Xr setlocale 3
|
||
|
|
.\" ----------------------------------------------------------------------
|
||
|
|
.Sh STANDARDS
|
||
|
|
The
|
||
|
|
.Fn towctrans
|
||
|
|
function conforms to
|
||
|
|
.St -isoC-amd1 .
|