fgets
Gets line from file pointer
Description
stringfgets
resourcehandle
intlength
Returns a string of up to length - 1 bytes read from the file
pointed to by handle. Reading ends when
length - 1 bytes have been read, on a newline (which is included
in the return value), or on EOF (whichever comes first). If no length
is specified, the length defaults to 1k, or 1024 bytes.
If an error occurs, returns &false;.
Common Pitfalls:
People used to the 'C' semantics of fgets
should note the difference in how EOF is returned.
The file pointer must be valid, and must point to a file
successfully opened by fopen,
popen, or
fsockopen.
A simple example follows:
Reading a file line by line
The length parameter became optional in PHP
4.2.0, if omitted, it would assume 1024 as the line length.
As of PHP 4.3, omitting length will keep
reading from the stream until it reaches the end of the line.
If the majority of the lines in the file are all larger than 8KB,
it is more resource efficient for your script to specify the maximum
line length.
This function is binary safe as of PHP 4.3. Earlier versions
were not binary safe.
¬e.line-endings;
See also fread,
fgetc,
stream_get_line,
fopen,
popen,
fsockopen, and
socket_set_timeout.