File::read()

Description

File::read() reads a specific amount of bytes from a specified file and returns them to the user.

Parameter

• string $filename - the file to read from

• int $size - the number of bytes to read from the file (defaults to FILE_DEFAULT_READSIZE)

• mixed $lock - lock type to use, FALSE if none

Return value

mixed - this function returns the requested bytes from the file if there were no errors, FALSE if it reached EOF or a PEAR_Error object if an error has occured during reading from file.

Throws

Note

This function can be called statically.

See

Example

<?php
require_once 'File.php';

//output 40 bytes of file foo.bar
echo File::read("/path/to/foo.bar", 40);
?>