RarArchive::getComment

RarArchive::getComment

rar_comment_get

Obtener comentarios de texto desde el archivo RAR

Descripción#

Estilo orientado a objetos (method):

public RarArchive::getComment(): string
```php

Estilo procedimental:

```php
rar_comment_get(RarArchive $rarfile): string

Obtener (global) comentario almacenado en el archivo RAR. Este puede ser de hasta 64 KiB de longitud.

[!NOTE] Esta extensión no es compatible con los comentarios en el nivel de entrada.

Parámetros#

rarfile
Un objeto RarArchive, abierto con rar_open.

Valores devueltos#

Devuelve el comentario o null si no hay ninguno.

[!NOTE] RAR no tiene actualmente soporte para comentarios unicode. La codificación de los resultados de esta función no es especificado, pero esta debe ser probablemente Windows-1252.

Ejemplos#

Estilo orientado a objetos

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

Resultado del ejemplo anterior es similar a:

This is the comment of the file commented.rar.

Estilo procedimental

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