]>
Commit | Line | Data |
---|---|---|
fea681da MK |
1 | .\" Copyright (c) Bruno Haible <haible@clisp.cons.org> |
2 | .\" | |
89e3ffe9 | 3 | .\" %%%LICENSE_START(GPLv2+_DOC_ONEPARA) |
fea681da MK |
4 | .\" This is free documentation; you can redistribute it and/or |
5 | .\" modify it under the terms of the GNU General Public License as | |
6 | .\" published by the Free Software Foundation; either version 2 of | |
7 | .\" the License, or (at your option) any later version. | |
fe382ebf | 8 | .\" %%%LICENSE_END |
fea681da MK |
9 | .\" |
10 | .\" References consulted: | |
11 | .\" GNU glibc-2 source code and manual | |
12 | .\" Dinkumware C library reference http://www.dinkumware.com/ | |
008f1ecc | 13 | .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html |
fea681da MK |
14 | .\" ISO/IEC 9899:1999 |
15 | .\" | |
460495ca | 16 | .TH WCTRANS 3 2015-08-08 "GNU" "Linux Programmer's Manual" |
fea681da | 17 | .SH NAME |
d0f17b57 | 18 | wctrans \- wide-character translation mapping |
fea681da MK |
19 | .SH SYNOPSIS |
20 | .nf | |
21 | .B #include <wctype.h> | |
68e4db0a | 22 | .PP |
fea681da MK |
23 | .BI "wctrans_t wctrans(const char *" name ); |
24 | .fi | |
25 | .SH DESCRIPTION | |
35cfd378 MK |
26 | The |
27 | .I wctrans_t | |
28 | type represents a mapping | |
c13182ef MK |
29 | which can map a wide character to |
30 | another wide character. | |
a43eed0c | 31 | Its nature is implementation-dependent, but the special |
51700fd7 | 32 | value |
35cfd378 MK |
33 | .IR "(wctrans_t)\ 0" |
34 | denotes an invalid mapping. | |
35 | Nonzero | |
36 | .I wctrans_t | |
60a90ecd | 37 | values can be passed to the |
ddb711a4 | 38 | .BR towctrans (3) |
60a90ecd | 39 | function to actually perform |
d0f17b57 | 40 | the wide-character mapping. |
fea681da | 41 | .PP |
60a90ecd MK |
42 | The |
43 | .BR wctrans () | |
44 | function returns a mapping, given by its name. | |
c13182ef | 45 | The set of |
1274071a MK |
46 | valid names depends on the |
47 | .B LC_CTYPE | |
48 | category of the current locale, but the | |
fea681da | 49 | following names are valid in all locales. |
a2b7a144 | 50 | .PP |
fea681da | 51 | .nf |
a2b7a144 MK |
52 | "tolower" \- realizes the \fBtolower\fP(3) mapping |
53 | "toupper" \- realizes the \fBtoupper\fP(3) mapping | |
fea681da | 54 | .fi |
47297adb | 55 | .SH RETURN VALUE |
60a90ecd MK |
56 | The |
57 | .BR wctrans () | |
35cfd378 MK |
58 | function returns a mapping descriptor if the |
59 | .I name | |
c13182ef | 60 | is valid. |
2b9b829d | 61 | Otherwise, it returns |
35cfd378 | 62 | .IR "(wctrans_t)\ 0" . |
afe8b228 | 63 | .SH ATTRIBUTES |
36419e2a PH |
64 | For an explanation of the terms used in this section, see |
65 | .BR attributes (7). | |
66 | .TS | |
67 | allbox; | |
68 | lb lb lb | |
69 | l l l. | |
70 | Interface Attribute Value | |
71 | T{ | |
afe8b228 | 72 | .BR wctrans () |
36419e2a PH |
73 | T} Thread safety MT-Safe locale |
74 | .TE | |
47297adb | 75 | .SH CONFORMING TO |
432ef7b2 | 76 | POSIX.1-2001, POSIX.1-2008, C99. |
fea681da | 77 | .SH NOTES |
d9bfdb9c | 78 | The behavior of |
60a90ecd | 79 | .BR wctrans () |
1274071a MK |
80 | depends on the |
81 | .B LC_CTYPE | |
82 | category of the | |
fea681da | 83 | current locale. |
47297adb | 84 | .SH SEE ALSO |
e37e3282 | 85 | .BR towctrans (3) |