RarArchive::getComment

rar_comment_get

(PECL rar >= 2.0.0)

RarArchive::getComment -- rar_comment_get — Obtém o texto de comentário do arquivo RAR

Descrição

Estilo orientado a objetos (method):

public RarArchive::getComment(): string

Estilo procedural:

rar_comment_get(RarArchive $rarfile): string

Obtém o comentário (global) armazenado no arquivo RAR. Pode ter até 64 KiB de comprimento.

Note:
Esta extensão não oferece suporte a comentários no nível de entrada.

Parâmetros

rarfile: Um objeto RarArchive, aberto com rar_open().

Valor Retornado

Retorna o comentário ou null se não houver nenhum.

Note:
Atualmente, o RAR não oferece suporte para comentários Unicode. A codificação do resultado desta função não está especificada, mas provavelmente será Windows-1252.

Exemplos

Example #1 Estilo orientado a objetos

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

O exemplo acima produzirá algo semelhante a:

This is the comment of the file commented.rar.

Example #2 Estilo procedural

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