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$ 38.\" 39.Dd January 10, 2003 40.Dt GETC 3 41.Os 42.Sh NAME 43.Nm fgetc , 44.Nm getc , 45.Nm getc_unlocked , 46.Nm getchar , 47.Nm getchar_unlocked , 48.Nm getw 49.Nd get next character or word from input stream 50.Sh LIBRARY 51.Lb libc 52.Sh SYNOPSIS 53.In stdio.h 54.Ft int 55.Fn fgetc "FILE *stream" 56.Ft int 57.Fn getc "FILE *stream" 58.Ft int 59.Fn getc_unlocked "FILE *stream" 60.Ft int 61.Fn getchar 62.Ft int 63.Fn getchar_unlocked "FILE *stream" 64.Ft int 65.Fn getw "FILE *stream" 66.Sh DESCRIPTION 67The 68.Fn fgetc 69function 70obtains the next input character (if present) from the stream pointed at by 71.Fa stream , 72or the next character pushed back on the stream via 73.Xr ungetc 3 . 74.Pp 75The 76.Fn getc 77function 78acts essentially identically to 79.Fn fgetc . 80.Pp 81The 82.Fn getchar 83function 84is equivalent to 85.Fn getc stdin . 86.Pp 87The 88.Fn getw 89function 90obtains the next 91.Vt int 92(if present) 93from the stream pointed at by 94.Fa stream . 95.Pp 96The 97.Fn getc_unlocked 98and 99.Fn getchar_unlocked 100functions are equivalent to 101.Fn getc 102and 103.Fn getchar 104respectively, 105except that the caller is responsible for locking the stream 106with 107.Xr flockfile 3 108before calling them. 109These functions may be used to avoid the overhead of locking the stream 110for each character, and to avoid input being dispersed among multiple 111threads reading from the same stream. 112.Sh RETURN VALUES 113If successful, these routines return the next requested object 114from the 115.Fa stream . 116Character values are returned as an 117.Vt "unsigned char" 118converted to an 119.Vt int . 120If the stream is at end-of-file or a read error occurs, 121the routines return 122.Dv EOF . 123The routines 124.Xr feof 3 125and 126.Xr ferror 3 127must be used to distinguish between end-of-file and error. 128If an error occurs, the global variable 129.Va errno 130is set to indicate the error. 131The end-of-file condition is remembered, even on a terminal, and all 132subsequent attempts to read will return 133.Dv EOF 134until the condition is cleared with 135.Xr clearerr 3 . 136.Sh SEE ALSO 137.Xr ferror 3 , 138.Xr flockfile 3 , 139.Xr fopen 3 , 140.Xr fread 3 , 141.Xr getwc 3 , 142.Xr putc 3 , 143.Xr ungetc 3 144.Sh STANDARDS 145The 146.Fn fgetc , 147.Fn getc 148and 149.Fn getchar 150functions 151conform to 152.St -isoC . 153The 154.Fn getc_unlocked 155and 156.Fn getchar_unlocked 157functions conform to 158.St -p1003.1-2001 . 159.Sh BUGS 160Since 161.Dv EOF 162is a valid integer value, 163.Xr feof 3 164and 165.Xr ferror 3 166must be used to check for failure after calling 167.Fn getw . 168The size and byte order of an 169.Vt int 170varies from one machine to another, and 171.Fn getw 172is not recommended for portable applications. 173.Pp 174