fgets

 

C

Language

Standard Library

Type support

Dynamic memory management

Error handling

Program utilities

Date and time utilities

Strings library

Algorithms

Numerics

Input/output support

Localization support

Thread support (C11)

Atomic operations (C11)

 

File input/output

Functions
File access
fopen freopen fclose fflush	fwide setbuf setvbuf
Direct input/output
fread
fwrite
Unformatted input/output
fgetc fgets fputc fputs getchar gets putchar puts ungetc	fgetwc fgetws fputwc fputws getwchar putwchar ungetwc
Formatted input/output
scanffscanfsscanf vscanfvfscanfvsscanf (C99)(C99)(C99) printffprintfsprintfsnprintf (C99) vprintfvfprintfvsprintfvsnprintf (C99)	wscanffwscanfswscanf vwscanfvfwscanfvswscanf (C99)(C99)(C99) wprintffwprintfswprintf vwprintfvfwprintfvswprintf
File positioning
ftell
fgetpos
fseek
fsetpos
rewind
Error handling
clearerr
feof
ferror
perror
Operations on files
remove
rename
tmpfile
tmpnam

 

Defined in header <stdio.h>
char *fgets( char          *str, int count, FILE          *stream );		(until C99)
char *fgets( char *restrict str, int count, FILE *restrict stream );		(since C99)

Reads at most count - 1 characters from the given file stream and stores them in str. The produced character string is always null-terminated. Parsing stops if end-of-file occurs or a newline character is found, in which case str will contain that newline character.

Parameters

str	-	string to read the characters to
count	-	the length of str
stream	-	file stream to read the data from

Return value

str on success, NULL on failure.

If the failure has been caused by end-of-file condition, additionally sets the eof indicator (see feof()) on stream. If the failure has been caused by some other error, sets the error indicator (see ferror()) on stream.

Example

fgets with error checking

Run this code

#include <stdio.h>
#include <stdlib.h>
 
int main(void)
{
    FILE* tmpf = tmpfile();
    fputs("Alan Turing\n", tmpf);
    fputs("John von Neumann\n", tmpf);
    fputs("Alonzo Church\n", tmpf);
 
    rewind(tmpf);
 
    char buf[8];
    while (fgets(buf, sizeof buf, tmpf) != NULL)
          printf("\"%s\"\n", buf);
 
    /* Test reason for reaching NULL. */
    if (feof(tmpf))          /* if failure caused by end-of-file condition */
       puts("End of file reached");
    else if (ferror(tmpf))   /* if failure caused by some other error      */
         {
            perror("fgets()");
            fprintf(stderr,"fgets() failed in file %s at line # %d\n", __FILE__,__LINE__-9);
            exit(EXIT_FAILURE);
         }
 
    return EXIT_SUCCESS;
}

Output:

"Alan Tu"
"ring
"
"John vo"
"n Neuma"
"nn
"
"Alonzo "
"Church
"
End of file reached

See also

scanffscanfsscanf	reads formatted input from stdin, a file stream or a buffer (function)
gets (until C11)	reads a character string from stdin (function)
fputs	writes a character string to a file stream (function)
C++ documentation for fgets