RarArchive::getComment

rar_comment_get

(PECL rar >= 2.0.0)

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

Beschreibung

Objektorientierter Stil (method):

public RarArchive::getComment ( ) : string

Prozeduraler Stil:

rar_comment_get ( RarArchive $rarfile ) : string

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

Beispiel #1 Objektorientierter Stil


<?php
$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.

Beispiel #2 Prozeduraler Stil


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