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