RarArchive::getComment
PHP function
Edit on GitHub ✎
(PECL rar >= 2.0.0)
Get comment text from the RAR archive
Description
Oop (method):
RarArchive::getComment(): string
Procedural:
rar_comment_get(RarArchive $rarfile): string
Get the (global) comment stored in the RAR archive. It may be up to 64 KiB long.
Note
This extension does not support comments at the entry level.
Parameters
rarfileA
RarArchiveobject, opened withrar_open().
Return Values
Returns the comment or null if there is none.
Note
RAR has currently no support for unicode comments. The encoding of the result of this function is not specified, but it will probably be Windows-1252.
Examples
Oop
php
<?php
$rar_arch = RarArchive::open('commented.rar');
echo $rar_arch->getComment();
?>The above example will output something similar to:
output
This is the comment of the file commented.rar.Procedural
php
<?php
$rar_arch = rar_open('commented.rar');
echo rar_comment_get($rar_arch);
?>