Edit Report a Bug

    RarArchive::getComment

    rar_comment_get

    (PECL rar >= 2.0.0)

    RarArchive::getComment -- rar_comment_get — Получить текст комментария из архива RAR

    Описание

    Объектно-ориентированный стиль (метод):

    public RarArchive::getComment(): string

    Процедурный стиль:

    rar_comment_get(RarArchive $rarfile): string

    Возвращает (глобальный) комментарий, сохранённый в архиве RAR. Он может быть длиной вплоть до 64 KiB.

    Замечание:

    Модуль не поддерживает комментарии на уровне записей.

    Список параметров

    rarfile

    Объект RarArchive, открытый с помощью rar_open().

    Возвращаемые значения

    Возвращает комментарий или null, если его нет.

    Замечание:

    RAR в текущий момент не поддерживает комментарии в unicode. Кодировка результата не определена, но, возможно, она будет Windows-1252.

    Примеры

    Пример #1 Объектно-ориентированный стиль

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

    Вывод приведённого примера будет похож на: 

    This is the comment of the file commented.rar.

    Пример #2 Процедурный стиль

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

    add a note add a note

    User Contributed Notes

    There are no user contributed notes for this page.
    To Top