gztell()

gztell() — Tell gz-file pointer read/write position.

Built-in function of PHP 8.5. The manual lists it as available in PHP 4, PHP 5, PHP 7, PHP 8. This page is the reference card: signature, parameters and return value, plus the changelog and the example the manual provides.

What it does

Gets the position of the given file pointer; i.e., its offset into the uncompressed file stream.

Signature

gztell(resource $stream): int|false

Parameters

ParameterTypeWhat it takes
$streamresourceThe gz-file pointer. It must be valid, and must point to a file successfully opened by gzopen().

Return value

The position of the file pointer or false if an error occurs.

Example

The PHP manual ships no example for gztell(); the signature and the parameter table above are the contract.

See also

gzopen(), gzseek(), gzrewind()

All PHP 8.5 built-in functions

Reference card built from the PHP manual page gztell() (PHP documentation, CC BY 3.0). The page is generated from the manual, so the wording of the parameter and return value text follows php.net.