xref: /openbsd/lib/libc/gen/iscntrl.3 (revision 5af055cd)
1.\"	$OpenBSD: iscntrl.3,v 1.11 2013/07/17 05:42:11 schwarze 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. Neither the name of the University nor the names of its contributors
19.\"    may be used to endorse or promote products derived from this software
20.\"    without specific prior written permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32.\" SUCH DAMAGE.
33.\"
34.Dd $Mdocdate: July 17 2013 $
35.Dt ISCNTRL 3
36.Os
37.Sh NAME
38.Nm iscntrl
39.Nd control character test
40.Sh SYNOPSIS
41.In ctype.h
42.Ft int
43.Fn iscntrl "int c"
44.Sh DESCRIPTION
45The
46.Fn iscntrl
47function tests for any control character.
48.Sh RETURN VALUES
49The
50.Fn iscntrl
51function returns zero if the character tests false or
52non-zero if the character tests true.
53.Sh SEE ALSO
54.Xr isalnum 3 ,
55.Xr isalpha 3 ,
56.Xr isascii 3 ,
57.Xr isblank 3 ,
58.Xr isdigit 3 ,
59.Xr isgraph 3 ,
60.Xr islower 3 ,
61.Xr isprint 3 ,
62.Xr ispunct 3 ,
63.Xr isspace 3 ,
64.Xr isupper 3 ,
65.Xr isxdigit 3 ,
66.Xr stdio 3 ,
67.Xr toascii 3 ,
68.Xr tolower 3 ,
69.Xr toupper 3 ,
70.Xr ascii 7
71.Sh STANDARDS
72The
73.Fn iscntrl
74function conforms to
75.St -ansiC .
76.Sh HISTORY
77The
78.Fn iscntrl
79function first appeared in
80.At v7 .
81.Sh CAVEATS
82The argument to
83.Fn iscntrl
84must be
85.Dv EOF
86or representable as an
87.Li unsigned char ;
88otherwise, the result is undefined.
89