Return to fgets.3 CVS log

Up to [CSRG BSD Unix] / 43BSDReno / lib / libc / stdio

Initial revision

.\" Copyright (c) 1989 The Regents of the University of California.
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms are permitted provided
.\" that: (1) source distributions retain this entire copyright notice and
.\" comment, and (2) distributions including binaries display the following
.\" acknowledgement:  ``This product includes software developed by the
.\" University of California, Berkeley and its contributors'' in the
.\" documentation or other materials provided with the distribution and in
.\" all advertising materials mentioning features or use of this software.
.\" Neither the name of the University nor the names of its contributors may
.\" be used to endorse or promote products derived from this software without
.\" specific prior written permission.
.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
.\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
.\"
.\"	@(#)fgets.3	6.4 (Berkeley) 6/23/90
.\"
.TH FGETS 3 "June 23, 1990"
.AT 3
.SH NAME
fgets - get a line from a stream
.SH SYNOPSIS
.nf
.B #include <stdio.h>

.B char *fgets(s, n, stream)
.B char *s;
.B int n;
.B FILE *stream;
.fi
.SH DESCRIPTION
The
.I fgets
function reads at most one less than the number of characters specified
by
.I n
from the stream pointed to by
.I stream
into the array pointed to by
.IR s .
No additional characters are read after a new-line character
(which is retained) or after end-of-file.
A null character is written immediately after the last character
read into the array.
.PP
The
.I fgets
function returns
.I s
if successful.
If end-of-file is encountered and no characters have been read
into the array, the contents of the array remain unchanged and
a null pointer is returned.
If a read error occurs during the operation, the array contents
are indeterminate and a null pointer is returned.
.SH "SEE ALSO"
getc(3), ferror(3) fread(3), scanf(3)
.SH STANDARDS
The
.I fgets
function is ANSI C compatible.

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.