array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'en', ), 'this' => array ( 0 => 'rararchive.close.php', 1 => 'RarArchive::close', 2 => 'Close RAR archive and free all resources', ), 'up' => array ( 0 => 'class.rararchive.php', 1 => 'RarArchive', ), 'prev' => array ( 0 => 'class.rararchive.php', 1 => 'RarArchive', ), 'next' => array ( 0 => 'rararchive.getcomment.php', 1 => 'RarArchive::getComment', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'en', 'path' => 'reference/rar/rararchive/close.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

RarArchive::close

rar_close

(PECL rar >= 2.0.0)

RarArchive::close -- rar_close — Close RAR archive and free all resources

Description

Object-oriented style (method):

public RarArchive::close(): bool

Procedural style:

rar_close(RarArchive $rarfile): bool

Close RAR archive and free all allocated resources.

Parameters

rarfile
A RarArchive object, opened with rar_open().

Return Values

Returns true on success or false on failure.

Changelog

Version Description
PECL rar 2.0.0 The RAR entries returned by RarArchive::getEntry() and RarArchive::getEntries() are now invalidated when calling this method. This means that all instance methods called for such entries and not guaranteed to succeed.

Examples

Example #1 Object-oriented style

<?php
$rar_arch = RarArchive::open('latest_winrar.rar');
echo $rar_arch."\n";
$rar_arch->close();
echo $rar_arch."\n";
?>

The above example will output something similar to:

RAR Archive "D:\php_rar\trunk\tests\latest_winrar.rar"
RAR Archive "D:\php_rar\trunk\tests\latest_winrar.rar" (closed)

Example #2 Procedural style

<?php
$rar_arch = rar_open('latest_winrar.rar');
echo $rar_arch."\n";
rar_close($rar_arch);
echo $rar_arch."\n";
?>