Debian Codegraph @

upstream/debian-trixie/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-05-02 "Linux man-pages 6.9.1"
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 .P
50 .nf
51 "tolower" \- realizes the \fBtolower\fP(3) mapping
52 "toupper" \- realizes the \fBtoupper\fP(3) mapping
53 .fi
54 .SH RETURN VALUE
55 The
56 .BR wctrans ()
57 function returns a mapping descriptor if the
58 .I name
59 is valid.
60 Otherwise, it returns
61 .IR "(wctrans_t)\ 0" .
62 .SH ATTRIBUTES
63 For an explanation of the terms used in this section, see
64 .BR attributes (7).
65 .TS
66 allbox;
67 lbx lb lb
68 l l l.
69 Interface Attribute Value
70 T{
71 .na
72 .nh
73 .BR wctrans ()
74 T} Thread safety MT-Safe locale
75 .TE
76 .SH STANDARDS
77 C11, POSIX.1-2008.
78 .SH HISTORY
79 POSIX.1-2001, C99.
80 .SH NOTES
81 The behavior of
82 .BR wctrans ()
83 depends on the
84 .B LC_CTYPE
85 category of the
86 current locale.
87 .SH SEE ALSO
88 .BR towctrans (3)