[apple/libc.git] / locale / towupper.3

.\" Copyright (c) 1989, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" This code is derived from software contributed to Berkeley by
.\" the American National Standards Committee X3, on Information
.\" Processing Systems.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"	@(#)toupper.3	8.1 (Berkeley) 6/4/93
.\" $FreeBSD: src/lib/libc/locale/towupper.3,v 1.2 2002/11/29 17:35:09 ru Exp $
.\"
.Dd October 3, 2002
.Dt TOWUPPER 3
.Os
.Sh NAME
.Nm towupper ,
.Nm towupper_l
.Nd "lower case to upper case letter conversion (wide character version)"
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In wctype.h
.Ft wint_t
.Fo towupper
.Fa "wint_t wc"
.Fc
.In wctype.h
.In xlocale.h
.Ft wint_t
.Fo towupper_l
.Fa "wint_t wc"
.Fa "locale_t loc"
.Fc
.Sh DESCRIPTION
The
.Fn towupper
function converts a lower-case letter to the corresponding
upper-case letter.
.Pp
Although the
.Fn towupper
function uses the current locale, the
.Fn towupper_l
function may be passed a locale directly. See
.Xr xlocale 3
for more information.
.Sh RETURN VALUES
If the argument is a lower-case letter, the
.Fn towupper
function returns the corresponding upper-case letter if there is
one; otherwise, the argument is returned unchanged.
.Sh SEE ALSO
.Xr iswupper 3 ,
.Xr toupper 3 ,
.Xr towlower 3 ,
.Xr wctrans 3 ,
.Xr xlocale 3
.Sh STANDARDS
The
.Fn towupper
function conforms to
.St -isoC-99 .
Commit	Line	Data
224c7076	1	.\" Copyright (c) 1989, 1991, 1993
e9ce8d39 A	2	.\" The Regents of the University of California. All rights reserved.
e9ce8d39 A	3	.\"
224c7076 A	4	.\" This code is derived from software contributed to Berkeley by
	5	.\" the American National Standards Committee X3, on Information
	6	.\" Processing Systems.
	7	.\"
e9ce8d39 A	8	.\" Redistribution and use in source and binary forms, with or without
	9	.\" modification, are permitted provided that the following conditions
	10	.\" are met:
	11	.\" 1. Redistributions of source code must retain the above copyright
	12	.\" notice, this list of conditions and the following disclaimer.
	13	.\" 2. Redistributions in binary form must reproduce the above copyright
	14	.\" notice, this list of conditions and the following disclaimer in the
	15	.\" documentation and/or other materials provided with the distribution.
	16	.\" 3. All advertising materials mentioning features or use of this software
	17	.\" must display the following acknowledgement:
	18	.\" This product includes software developed by the University of
	19	.\" California, Berkeley and its contributors.
	20	.\" 4. Neither the name of the University nor the names of its contributors
	21	.\" may be used to endorse or promote products derived from this software
	22	.\" without specific prior written permission.
	23	.\"
	24	.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	25	.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	26	.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	27	.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	28	.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	29	.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	30	.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	31	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	32	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	33	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	34	.\" SUCH DAMAGE.
	35	.\"
224c7076 A	36	.\" @(#)toupper.3 8.1 (Berkeley) 6/4/93
224c7076 A	37	.\" $FreeBSD: src/lib/libc/locale/towupper.3,v 1.2 2002/11/29 17:35:09 ru Exp $
e9ce8d39	38	.\"
224c7076 A	39	.Dd October 3, 2002
224c7076 A	40	.Dt TOWUPPER 3
e9ce8d39 A	41	.Os
e9ce8d39 A	42	.Sh NAME
224c7076 A	43	.Nm towupper ,
	44	.Nm towupper_l
	45	.Nd "lower case to upper case letter conversion (wide character version)"
e9ce8d39 A	46	.Sh LIBRARY
	47	.Lb libc
	48	.Sh SYNOPSIS
224c7076 A	49	.In wctype.h
	50	.Ft wint_t
	51	.Fo towupper
	52	.Fa "wint_t wc"
	53	.Fc
	54	.In wctype.h
	55	.In xlocale.h
	56	.Ft wint_t
	57	.Fo towupper_l
	58	.Fa "wint_t wc"
	59	.Fa "locale_t loc"
	60	.Fc
e9ce8d39 A	61	.Sh DESCRIPTION
e9ce8d39 A	62	The
224c7076 A	63	.Fn towupper
	64	function converts a lower-case letter to the corresponding
	65	upper-case letter.
	66	.Pp
	67	Although the
	68	.Fn towupper
	69	function uses the current locale, the
	70	.Fn towupper_l
	71	function may be passed a locale directly. See
	72	.Xr xlocale 3
	73	for more information.
e9ce8d39	74	.Sh RETURN VALUES
224c7076 A	75	If the argument is a lower-case letter, the
	76	.Fn towupper
	77	function returns the corresponding upper-case letter if there is
	78	one; otherwise, the argument is returned unchanged.
e9ce8d39	79	.Sh SEE ALSO
224c7076 A	80	.Xr iswupper 3 ,
	81	.Xr toupper 3 ,
	82	.Xr towlower 3 ,
	83	.Xr wctrans 3 ,
	84	.Xr xlocale 3
	85	.Sh STANDARDS
5b2abdfb	86	The
224c7076 A	87	.Fn towupper
	88	function conforms to
	89	.St -isoC-99 .