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.

Замечание:

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.

Замечание:

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.


Примеры

Пример #1 Объектно-ориентированный стиль вызова
$rar_arch = RarArchive::open('commented.rar'); 
echo $rar_arch->getComment();

Результатом выполнения данного примера будет что-то подобное:


This is the comment of the file commented.rar.

Пример #2 Процедурный стиль вызова
$rar_arch = rar_open('commented.rar'); 
echo rar_comment_get($rar_arch);


Описание класса rararchive, примеры использования класса rararchive.



Смотрите также:
Описание на ru2.php.net
Описание на php.ru