Copyright (c) 1989 The Regents of the University of California.
All rights reserved.

%sccs.include.redist.man%

@(#)fgets.3 6.4 (Berkeley) 06/23/90

.AT 3 fgets - get a line from a stream

 #include <stdio.h> 
 char *fgets(s, n, stream)  char *s;  int n;  FILE *stream; 

The fgets function reads at most one less than the number of characters specified by n from the stream pointed to by stream into the array pointed to by 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.

The fgets function returns 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.

getc(3), ferror(3) fread(3), scanf(3) The fgets function is ANSI C compatible.