RarArchive::getComment

rar_comment_get

Get comment text from the RAR archive

&reftitle.description;

&style.oop; (method):

public `string` `RarArchive::getComment`

&style.procedural;:

`string` `rar_comment_get` `RarArchive` `rarfile`

Get the (global) comment stored in the RAR archive. It may be up to 64 KiB long.

This extension does not support comments at the entry level.

&reftitle.parameters;

`rarfile`

- A `RarArchive` object, opened with `rar_open`.

&reftitle.returnvalues;

Returns the comment or &null; if there is none.

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.

&reftitle.examples;

### &style.oop;

    <?php
    $rar_arch = RarArchive::open('commented.rar');
    echo $rar_arch->getComment();
    ?>

&example.outputs.similar;

    This is the comment of the file commented.rar.

### &style.procedural;

    <?php
    $rar_arch = rar_open('commented.rar');
    echo rar_comment_get($rar_arch);
    ?>