gzseek()

gzseek() — Seek on a gz-file pointer.

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

Sets the file position indicator for the given file pointer to the given offset byte into the file stream. Equivalent to calling (in C) gzseek(zp, offset, SEEK_SET).

Signature

gzseek(resource $stream, int $offset, int $whence = SEEK_SET): int

Parameters

Parameter	Type	What it takes
$stream	resource	The gz-file pointer. It must be valid, and must point to a file successfully opened by gzopen().
$offset	int	The seeked offset.
$whence	int	whence values are: SEEK_SET - Set position equal to offset bytes. SEEK_CUR - Set position to current location plus offset.

Return value

Upon success, returns 0; otherwise, returns -1. Note that seeking past EOF is not considered an error.

Example

A runnable snippet:

$gz = gzopen('somefile.gz', 'r'); gzseek($gz,2); echo gzgetc($gz); gzclose($gz);