summaryrefslogtreecommitdiffstats
path: root/upstream/archlinux/man3p/towupper.3p
blob: cdc22b3baca3d6506b106a701ea196d6175b7069 (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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
'\" et
.TH TOWUPPER "3P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual"
.\"
.SH PROLOG
This manual page is part of the POSIX Programmer's Manual.
The Linux implementation of this interface may differ (consult
the corresponding Linux manual page for details of Linux behavior),
or the interface may not be implemented on Linux.
.\"
.SH NAME
towupper,
towupper_l
\(em transliterate lowercase wide-character code to uppercase
.SH SYNOPSIS
.LP
.nf
#include <wctype.h>
.P
wint_t towupper(wint_t \fIwc\fP);
wint_t towupper_l(wint_t \fIwc\fP, locale_t \fIlocale\fP);
.fi
.SH DESCRIPTION
For
\fItowupper\fR():
The functionality described on this reference page is aligned with the
ISO\ C standard. Any conflict between the requirements described here and the
ISO\ C standard is unintentional. This volume of POSIX.1\(hy2017 defers to the ISO\ C standard.
.P
The
\fItowupper\fR()
and
\fItowupper_l\fR()
functions have as a domain a type
.BR wint_t ,
the value of which the application shall ensure is a character
representable as a
.BR wchar_t ,
and a wide-character code corresponding to a valid character in the
locale used by the function or the value of WEOF.
If the argument has any other value, the behavior is undefined.
If the argument of
\fItowupper\fR()
or
\fItowupper_l\fR()
represents a lowercase wide-character code, and there exists a
corresponding uppercase wide-character code as defined by character
type information in the current locale
or in the locale represented by
.IR locale ,
respectively (category
.IR LC_CTYPE ),
the result shall be the corresponding uppercase wide-character code.
All other arguments in the domain are returned unchanged.
.P
The behavior is undefined if the
.IR locale
argument to
\fItowupper_l\fR()
is the special locale object LC_GLOBAL_LOCALE or is not a valid locale
object handle.
.SH "RETURN VALUE"
Upon successful completion, the
\fItowupper\fR()
and
\fItowupper_l\fR()
functions shall return the uppercase letter corresponding to the
argument passed. Otherwise, they shall return the argument unchanged.
.SH ERRORS
No errors are defined.
.LP
.IR "The following sections are informative."
.SH EXAMPLES
None.
.SH "APPLICATION USAGE"
None.
.SH RATIONALE
None.
.SH "FUTURE DIRECTIONS"
None.
.SH "SEE ALSO"
.IR "\fIsetlocale\fR\^(\|)",
.IR "\fIuselocale\fR\^(\|)"
.P
The Base Definitions volume of POSIX.1\(hy2017,
.IR "Chapter 7" ", " "Locale",
.IR "\fB<locale.h>\fP",
.IR "\fB<wctype.h>\fP"
.\"
.SH COPYRIGHT
Portions of this text are reprinted and reproduced in electronic form
from IEEE Std 1003.1-2017, Standard for Information Technology
-- Portable Operating System Interface (POSIX), The Open Group Base
Specifications Issue 7, 2018 Edition,
Copyright (C) 2018 by the Institute of
Electrical and Electronics Engineers, Inc and The Open Group.
In the event of any discrepancy between this version and the original IEEE and
The Open Group Standard, the original IEEE and The Open Group Standard
is the referee document. The original Standard can be obtained online at
http://www.opengroup.org/unix/online.html .
.PP
Any typographical or formatting errors that appear
in this page are most likely
to have been introduced during the conversion of the source files to
man page format. To report such errors, see
https://www.kernel.org/doc/man-pages/reporting_bugs.html .