Debian Codegraph @

upstream/fedora-44/man3/wctrans.3

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