programming.nbk: Home | Index | Next Page: fopen() | Previous Page: fgetc()

 fgets(char *str, int num, FILE *stream);

Syntax

char *fgets(char *str, int num, FILE *stream);

Get string from stream

Reads characters from stream and stores them as a C string into str until (num-1) characters have been read or either a newline or a the End-of-File is reached, whichever comes first. A newline character makes fgets stop reading, but it is considered a valid character and therefore it is included in the string copied to str. A null character is automatically appended in str after the characters read to signal the end of the C string.

Parameters

• str
  Pointer to an array of chars where the string read is stored.
• num
  Maximum number of characters to be read (including the final null-character). Usually, the length of the array passed as str is used.
• stream
  Pointer to a FILE object that identifies the stream where characters are read from. To read from the standard input, stdin can be used for this parameter.

Return Value

On success, the function returns the same str parameter.

If the End-of-File is encountered and no characters have been read, the contents of str remain unchanged and a null pointer is returned.

If an error occurs, a null pointer is returned.

Use either ferror or feof to check whether an error happened or the End-of-File was reached.

programming.nbk: Home | Index | Next Page: fopen() | Previous Page: fgetc()

Notebook exported on Monday, 7 July 2008, 18:56:06 PM Eastern Daylight Time