summaryrefslogtreecommitdiff
path: root/man3/wctrans.3
blob: 63b4400a49500154179665f76b8ed7eaee0556b1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
.\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
.\"
.\" This is free documentation; you can redistribute it and/or
.\" modify it under the terms of the GNU General Public License as
.\" published by the Free Software Foundation; either version 2 of
.\" the License, or (at your option) any later version.
.\"
.\" References consulted:
.\"   GNU glibc-2 source code and manual
.\"   Dinkumware C library reference http://www.dinkumware.com/
.\"   OpenGroup's Single Unix specification http://www.UNIX-systems.org/online.html
.\"   ISO/IEC 9899:1999
.\"
.TH WCTRANS 3  1999-07-25 "GNU" "Linux Programmer's Manual"
.SH NAME
wctrans \- wide-character translation mapping
.SH SYNOPSIS
.nf
.B #include <wctype.h>
.sp
.BI "wctrans_t wctrans(const char *" name );
.fi
.SH DESCRIPTION
The \fBwctrans_t\fP type represents a mapping
which can map a wide character to
another wide character.
Its nature is implementation dependent, but the special
value \fI(wctrans_t)\ 0\fP denotes an invalid mapping.
Nonzero \fBwctrans_t\fP
values can be passed to the
.BR towctrans ()
function to actually perform
the wide-character mapping.
.PP
The
.BR wctrans ()
function returns a mapping, given by its name.
The set of
valid names depends on the
.B LC_CTYPE
category of the current locale, but the
following names are valid in all locales.
.nf
  "tolower" \- realizes the \fBtolower\fP(3) mapping
  "toupper" \- realizes the \fBtoupper\fP(3) mapping
.fi
.SH "RETURN VALUE"
The
.BR wctrans ()
function returns a mapping descriptor if the \fIname\fP
is valid.
Otherwise it returns \fI(wctrans_t) 0\fP.
.SH "CONFORMING TO"
C99.
.SH NOTES
The behavior of
.BR wctrans ()
depends on the
.B LC_CTYPE
category of the
current locale.
.SH "SEE ALSO"
.BR towctrans (3)