RarArchive::getComment

rar_comment_get

(PECL rar >= 2.0.0)

RarArchive::getComment -- rar_comment_get — 从 RAR 档案中获取注释文本

面向对象风格 (方法)

public RarArchive::getComment(): string

过程式风格

rar_comment_get(RarArchive $rarfile): string

获取存储在 RAR 档案中的（全局）注释。它最长可达 64 KiB。

注意:
此扩展不支持条目级别的注释。

返回注释，如果不存在则返回 null。

注意:
RAR 目前不支持 Unicode 注释。此函数结果的编码未指定，但可能是 Windows-1252。

示例 #1 面向对象风格

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

以上示例将输出类似于以下内容

This is the comment of the file commented.rar.

示例 #2 过程式风格

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

此页面没有用户贡献的注释。