Php/docs/rararchive.close

From Get docs

RarArchive::close

rar_close

(PECL rar >= 2.0.0)

RarArchive::close -- rar_closeClose 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";?>