Home > PHP > Function > Streams > stream_get_contents()

stream_get_contents()

stream_get_contents - Reads remainder of a stream into a string

Syntax

string stream_get_contents (resource $handle, int $maxlength, int $offset)

Arguments

  • handle - A stream resource (e.g. returned from fopen())
  • maxlength - The maximum bytes to read. Defaults to -1 (read all the remaining buffer).
  • offset - Seek to the specified offset before reading.

Description

Identical to file_get_contents(), except that stream_get_contents() operates on an already open stream resource and returns the remaining contents in a string, up to maxlength bytes and starting at the specified offset.

Version

PHP 5

Return value

Returns a string or FALSE on failure.