summaryrefslogtreecommitdiff
path: root/usr/src/man/man3c/towlower.3c
blob: e0024720b45422de84737543651bd2f1129f6cda (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
'\" te
.\"
.\" This file and its contents are supplied under the terms of the
.\" Common Development and Distribution License ("CDDL"), version 1.0.
.\" You may only use this file in accordance with the terms of version
.\" 1.0 of the CDDL.
.\"
.\" A full copy of the text of the CDDL should have accompanied this
.\" source.  A copy of the CDDL is also available via the Internet at
.\" http://www.illumos.org/license/CDDL.
.\"
.\"
.\" Copyright (c) 2014 Joyent, Inc.  All rights reserved.
.\" Copyright 2014 Garrett D'Amore <garrett@damore.org>
.\"
.TH TOWLOWER 3C "Jun 21, 2014"
.SH NAME
towlower, towlower_l \- transliterate upper-case wide characters to lower-case
.SH SYNOPSIS
.LP
.nf
#include <wctype.h>

\fBwint_t\fR \fBtowlower\fR(\fBwint_t\fR \fIwc\fR);
.fi
.LP
.nf
\fBwint_t\fR \fBtowlower_l\fR(\fBwint_t\fR \fIwc\fR, \fBlocale_t\fR \fIloc\fR);
.nf
.SH DESCRIPTION
The function
.BR towlower()
is the wide character equivalent of the function
.BR tolower (3C).
It converts the upper-case wide character
.I wc
to the equivalent lower-case
wide character, if one exists. If one does not exist, it returns
.I wc
unchanged.
.LP
The function
.B towlower_l()
is equivalent to the function
.BR towlower() ,
but instead of operating in the current locale, operates in the
locale specified by
.IR loc .
.SH RETURN VALUES
On successful completion,
.B towlower()
and
.B towlower_l()
return the lower-case character that corresponds to the argument passed.
Otherwise, they return the argument unchanged.
.SH ERRORS
No errors are defined.
.SH ATTRIBUTES
.TS
box;
c | c
l | l .
ATTRIBUTE TYPE	ATTRIBUTE VALUE
_
Interface Stability	Standard
_
MT-Level	MT-Safe
.TE

.SH SEE ALSO
.BR newlocale (3C),
.BR setlocale (3C),
.BR towupper (3C),
.BR uselocale (3C),
.BR locale (5)