xref: /dragonfly/lib/libc/stdio/getc.3 (revision 49781055)
1.\" Copyright (c) 1990, 1991, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" This code is derived from software contributed to Berkeley by
5.\" Chris Torek and the American National Standards Committee X3,
6.\" on Information Processing Systems.
7.\"
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.\"
36.\"     @(#)getc.3	8.1 (Berkeley) 6/4/93
37.\" $FreeBSD: src/lib/libc/stdio/getc.3,v 1.5.2.6 2002/05/19 00:24:57 fanf Exp $
38.\" $DragonFly: src/lib/libc/stdio/getc.3,v 1.3 2005/09/25 20:49:55 asmodai Exp $
39.\"
40.Dd June 4, 1993
41.Dt GETC 3
42.Os
43.Sh NAME
44.Nm fgetc ,
45.Nm getc ,
46.Nm getchar ,
47.Nm getw
48.Nd get next character or word from input stream
49.Sh LIBRARY
50.Lb libc
51.Sh SYNOPSIS
52.In stdio.h
53.Ft int
54.Fn fgetc "FILE *stream"
55.Ft int
56.Fn getc "FILE *stream"
57.Ft int
58.Fn getchar "void"
59.Ft int
60.Fn getw "FILE *stream"
61.Sh DESCRIPTION
62The
63.Fn fgetc
64function
65obtains the next input character (if present) from the stream pointed at by
66.Fa stream ,
67or the next character pushed back on the stream via
68.Xr ungetc 3 .
69.Pp
70The
71.Fn getc
72function
73acts essentially identically to
74.Fn fgetc ,
75but is a macro that expands in-line.
76.Pp
77The
78.Fn getchar
79function
80is equivalent to
81.Fn getc stdin .
82.Pp
83The
84.Fn getw
85function
86obtains the next
87.Em int
88(if present)
89from the stream pointed at by
90.Fa stream .
91.Sh RETURN VALUES
92If successful, these routines return the next requested object
93from the
94.Fa stream .
95Character values are returned as an
96.Li unsigned char
97converted to an
98.Li int .
99If the stream is at end-of-file or a read error occurs,
100the routines return
101.Dv EOF .
102The routines
103.Xr feof 3
104and
105.Xr ferror 3
106must be used to distinguish between end-of-file and error.
107If an error occurs, the global variable
108.Va errno
109is set to indicate the error.
110The end-of-file condition is remembered, even on a terminal, and all
111subsequent attempts to read will return
112.Dv EOF
113until the condition is cleared with
114.Xr clearerr 3 .
115.Sh SEE ALSO
116.Xr ferror 3 ,
117.Xr fopen 3 ,
118.Xr fread 3 ,
119.Xr putc 3 ,
120.Xr ungetc 3
121.Sh STANDARDS
122The
123.Fn fgetc ,
124.Fn getc
125and
126.Fn getchar
127functions
128conform to
129.St -isoC .
130.Sh BUGS
131Since
132.Dv EOF
133is a valid integer value,
134.Xr feof 3
135and
136.Xr ferror 3
137must be used to check for failure after calling
138.Fn getw .
139The size and byte order of an
140.Em int
141varies from one machine to another, and
142.Fn getw
143is not recommended for portable applications.
144.Pp
145