xref: /netbsd/lib/libc/gen/isupper.3 (revision c4a72b64)
1.\"	$NetBSD: isupper.3,v 1.9 2002/07/10 14:37:14 yamt Exp $
2.\"
3.\" Copyright (c) 1991 The Regents of the University of California.
4.\" All rights reserved.
5.\"
6.\" This code is derived from software contributed to Berkeley by
7.\" the American National Standards Committee X3, on Information
8.\" Processing Systems.
9.\"
10.\" Redistribution and use in source and binary forms, with or without
11.\" modification, are permitted provided that the following conditions
12.\" are met:
13.\" 1. Redistributions of source code must retain the above copyright
14.\"    notice, this list of conditions and the following disclaimer.
15.\" 2. Redistributions in binary form must reproduce the above copyright
16.\"    notice, this list of conditions and the following disclaimer in the
17.\"    documentation and/or other materials provided with the distribution.
18.\" 3. All advertising materials mentioning features or use of this software
19.\"    must display the following acknowledgement:
20.\"	This product includes software developed by the University of
21.\"	California, Berkeley and its contributors.
22.\" 4. Neither the name of the University nor the names of its contributors
23.\"    may be used to endorse or promote products derived from this software
24.\"    without specific prior written permission.
25.\"
26.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
27.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
30.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36.\" SUCH DAMAGE.
37.\"
38.\"     @(#)isupper.3	5.2 (Berkeley) 6/29/91
39.\"
40.Dd June 29, 1991
41.Dt ISUPPER 3
42.Os
43.Sh NAME
44.Nm isupper
45.Nd upper-case character test
46.Sh LIBRARY
47.Lb libc
48.Sh SYNOPSIS
49.Fd #include \*[Lt]ctype.h\*[Gt]
50.Ft int
51.Fn isupper "int c"
52.Sh DESCRIPTION
53The
54.Fn isupper
55function tests for any upper-case letter or any of an
56implementation-defined set of characters for which none of
57.Xr iscntrl 3 ,
58.Xr isdigit 3 ,
59.Xr ispunct 3 ,
60or
61.Xr isspace 3
62is true.
63In the
64.Em ``C''
65locale,
66.Fn isupper
67returns true only for the characters defined as upper-case letters.
68.Sh RETURN VALUES
69The
70.Fn isupper
71macro returns zero if the character tests false and
72returns non-zero if the character tests true.
73.Sh SEE ALSO
74.Xr isalnum 3 ,
75.Xr isalpha 3 ,
76.Xr isascii 3 ,
77.Xr isblank 3 ,
78.Xr iscntrl 3 ,
79.Xr isdigit 3 ,
80.Xr isgraph 3 ,
81.Xr islower 3 ,
82.Xr isprint 3 ,
83.Xr ispunct 3 ,
84.Xr isspace 3 ,
85.Xr isxdigit 3 ,
86.Xr stdio 3 ,
87.Xr toascii 3 ,
88.Xr tolower 3 ,
89.Xr toupper 3 ,
90.Xr ascii 7
91.Sh STANDARDS
92The
93.Fn isupper
94function conforms to
95.St -ansiC .
96.Sh CAVEATS
97The argument to
98.Fn isupper
99must be
100.Dv EOF
101or representable as an
102.Li unsigned char ;
103otherwise, the result is undefined.
104