Debian Codegraph @

upstream/debian-unstable/man3/wctrans.3

raw
1 '\" t
2 .\" Copyright, Bruno Haible <[email protected]>
3 .\" Copyright, the authors of the Linux man-pages project
4 .\"
5 .\" SPDX-License-Identifier: GPL-2.0-or-later
6 .\"
7 .TH wctrans 3 2026-02-08 "Linux man-pages 6.18"
8 .SH NAME
9 wctrans \- wide-character translation mapping
10 .SH LIBRARY
11 Standard C library
12 .RI ( libc ,\~ \-lc )
13 .SH SYNOPSIS
14 .nf
15 .B #include <wctype.h>
16 .P
17 .BI "wctrans_t wctrans(const char *" name );
18 .fi
19 .SH DESCRIPTION
20 The
21 .I wctrans_t
22 type represents a mapping
23 which can map a wide character to
24 another wide character.
25 Its nature is implementation-dependent, but the special
26 value
27 .I (wctrans_t)\ 0
28 denotes an invalid mapping.
29 Nonzero
30 .I wctrans_t
31 values can be passed to the
32 .BR towctrans (3)
33 function to actually perform
34 the wide-character mapping.
35 .P
36 The
37 .BR wctrans ()
38 function returns a mapping, given by its name.
39 The set of
40 valid names depends on the
41 .B LC_CTYPE
42 category of the current locale, but the
43 following names are valid in all locales.
44 .IP
45 .TS
46 L1 Lx.
47 "tolower" \- realizes the \f[B]tolower\f[](3) mapping
48 "toupper" \- realizes the \f[B]toupper\f[](3) mapping
49 .TE
50 .SH RETURN VALUE
51 The
52 .BR wctrans ()
53 function returns a mapping descriptor if the
54 .I name
55 is valid.
56 Otherwise, it returns
57 .IR "(wctrans_t)\ 0" .
58 .SH ATTRIBUTES
59 For an explanation of the terms used in this section, see
60 .BR attributes (7).
61 .TS
62 allbox;
63 lbx lb lb
64 l l l.
65 Interface Attribute Value
66 T{
67 .na
68 .nh
69 .BR wctrans ()
70 T} Thread safety MT-Safe locale
71 .TE
72 .SH STANDARDS
73 C11, POSIX.1-2008.
74 .SH HISTORY
75 POSIX.1-2001, C99.
76 .SH NOTES
77 The behavior of
78 .BR wctrans ()
79 depends on the
80 .B LC_CTYPE
81 category of the
82 current locale.
83 .SH SEE ALSO
84 .BR towctrans (3)