fgets() -- read string from stream

SYNOPSIS

#include <stdio.h>

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

The fgets() function reads at most n-1 characters from stream into the buffer pointed to by s. No additional characters are read after fgets() has read and transferred a newline character to the buffer. A null character is written immediately after the last character that fgets() reads into the buffer.

PARAMETERS

s: Points to a buffer that is to hold the characters read.
n: Is the size, in bytes, of the buffer pointed to by s.
stream: Is the stream from which the characters are read.

RETURN VALUES

If successful, fgets() returns s, the address of the input buffer. If end-of-file is encountered and no characters have been read into the buffer, the buffer's contents remain unchanged and a null pointer is returned. If a read error occurs , a null pointer is returned and the error indicator for the stream is set. The functions ferror() and feof() can be used to distinguish error conditions from end-of-file.

On failure, errno is set to one of the following values:

EACCES: Another process has the file locked.
EBADF: stream is not a valid stream opened for reading.
EINTR: A signal interrupted the call.
EIO: An input error occurred.
EISDIR: The open object is a directory, not a file.
ENOMEM: Memory could not be allocated for internal buffers.
ENXIO: A device error occurred.
EOVERFLOW: The file is a regular file and an attempt was made to read at or beyond the offset maximum associated with the corresponding stream.
EWOULDBLOCK: The underlying file descriptor is a non-blocking socket and no data is ready to be read.

fgets()
read string from stream

Function

SYNOPSIS

DESCRIPTION

PARAMETERS

RETURN VALUES

CONFORMANCE

MULTITHREAD SAFETY LEVEL

PORTING ISSUES

AVAILABILITY

SEE ALSO

fgets() read string from stream

Function

fgets()
read string from stream