Home/ Manual/ zlib / functions/ gzread

gzread

PHP function Edit on GitHub ✎

(PHP 4, PHP 5, PHP 7, PHP 8)

Binary-safe gz-file read

Description

gzread(resource $stream, int $length): string|false

gzread() reads up to length bytes from the given gz-file pointer. Reading stops when length (uncompressed) bytes have been read or EOF is reached, whichever comes first.

Parameters

stream: The gz-file pointer. It must be valid, and must point to a file successfully opened by gzopen().
length: The number of bytes to read.

Return Values

The data that have been read, Falseforfailure.

Changelog

Version	Description
7.4.0	This functions returns false on failure now; previously `0` was returned.

Examples

gzread() example

php

<?php
// get contents of a gz-file into a string
$filename = "/usr/local/something.txt.gz";
$zd = gzopen($filename, "r");
$contents = gzread($zd, 10000);
gzclose($zd);
?>