Submit a Pull Request Report a Bug

    RarArchive::getComment

    rar_comment_get

    (PECL rar >= 2.0.0)

    RarArchive::getComment -- rar_comment_get — Get comment text from the RAR archive

    說明

    物件導向風格 (method):

    public string RarArchive::getComment ( void )

    程序化風格:

    string rar_comment_get ( RarArchive $rarfile )

    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.

    參數

    rarfile

    A RarArchive object, opened with rar_open().

    回傳值

    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.

    範例

    Example #1 物件導向風格

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

    上例的輸出類似於：

    This is the comment of the file commented.rar.

    Example #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