PHP Portal » PHP Handbuch » RarArchive::getComment

Werbung

RarArchive::getComment

RarArchive PHP Manual

(PECL rar >= 2.0.0)

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

Beschreibung

Object oriented style (method):

public string RarArchive::getComment ( void )

Procedural style:

string rar_comment_get ( RarArchive $rarfile )

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

Hinweis: This extension does not support comments at the entry level.

Parameter-Liste

rarfile

A RarArchive object, opened with rar_open().

Rückgabewerte

Returns the comment or NULL if there is none.

Hinweis: 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.

Beispiele

PHP Code
1
2
$rar_arch = RarArchive::open('commented.rar'); echo $rar_arch->getComment();

Das oben gezeigte Beispiel erzeugt eine ähnliche Ausgabe wie:

This is the comment of the file commented.rar.

PHP Code
1
2
$rar_arch = rar_open('commented.rar'); echo rar_comment_get($rar_arch);

RarArchive PHP Manual