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.
Зауваження :
Модуль не підтримує коментарів на рівні записів.
Список параметрів
rarfile
Об'єкт RarArchive, відкритий за допомогою rar_open()
Значення, що повертаються
Повертає коментар або **null**якщо його немає.
Зауваження :
RAR зараз не підтримує коментарі в unicode. Кодування результату не визначено, але, можливо, воно буде Windows-1252.
Приклади
Приклад #1 Об'єктно-орієнтований стиль
Висновок наведеного прикладу буде схожим на:
This is the comment of the file commented.rar.
Приклад #2 Процедурний стиль