php8.5
Home/ Manual/ bzip2 / functions/ bzopen

bzopen

PHP function Edit on GitHub ✎

(PHP 4 >= 4.0.4, PHP 5, PHP 7, PHP 8)

Opens a bzip2 compressed file

Description

bzopen(string|resource $file, string $mode): resource|false

bzopen() opens a bzip2 (.bz2) file for reading or writing.

Parameters

file

The name of the file to open, or an existing stream resource.

mode

The modes 'r' (read), and 'w' (write) are supported. Everything else will cause bzopen() to return false.

Return Values

If the open fails, bzopen() returns false, otherwise it returns a pointer to the newly opened file.

Examples

bzopen() example

php
<?php

$file = "/tmp/foo.bz2";
$bz = bzopen($file, "r") or die("Couldn't open $file for reading");

bzclose($bz);

?>

See Also

Source: reference/bzip2/functions/bzopen.xml · from the official PHP manual (php/doc-en)