RarArchive::getComment()
(PECL rar >= 2.0.0)
Get comment text from the RAR archive
说明
面向对象风格(method):
public RarArchive::getComment(void): string
过程化风格:
rar_comment_get(RarArchive$rarfile): string
Get the(global)comment stored in the RAR archive. It may be up to 64 KiB long.
Note: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.
Note: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.
范例
Example #1 面向对象风格
<?php $rar_arch = RarArchive::open('commented.rar'); echo $rar_arch->getComment(); ?>
以上例程的输出类似于:
This is the comment of the file commented.rar.
Example #2 过程化风格
<?php $rar_arch = rar_open('commented.rar'); echo rar_comment_get($rar_arch); ?>