Read a character array from a stream.

This function is compatible with the following targets:

ANSI

BeOS

EMB/RTOS

Mac OS

Palm OS

Win32

#include <stdio.h>

char *fgets(char *s, int n, FILE *stream);

Parameters for this facility are:

s	char *	The destination string
n	int	The maximum number of chars read
stream	FILE *	A pointer to a FILE stream

The fgets() function reads characters sequentially from stream beginning at the current file position, and assembles them into s as a character array. The function stops reading characters when n characters have been read. The fgets() function finishes reading prematurely if it reaches a newline ('\n') character or the end-of-file.

If the file is opened in update mode (+) a file cannot be read from and then written to without repositioning the file using one of the file positioning functions (fseek(), fsetpos(), or rewind()) unless the last read or write reached the end-of-file.

Unlike the gets() function, fgets() appends the newline character ('\n') to s. It also null terminates the characters written into the character array.

fgets() returns a pointer to s if it is successful. If it reaches the end-of-file before reading any characters, s is untouched and fgets() returns a null pointer (NULL). If an error occurs fgets() returns a null pointer and the contents of s may be corrupted.

"Wide Character and Byte Character Stream Orientation"

"gets"

Refer to "Example of feof() usage." for feof().