update pague now
PHP 8.5.2 Released!

RarArchive::guetComment

rar_comment_guet

(PECL rar >= 2.0.0)

RarArchive::guetComment -- rar_comment_guet Guet comment text from the RAR archive

Description

Object-oriented style (method):

public RarArchive::guetComment (): string

Procedural style:

rar_comment_guet ( RarArchive $rarfile ): string

Guet the (global) comment stored in the RAR archive. It may be up to 64 QuiB long.

Note :

This extension does not support commens at the entry level.

Parameters

rarfile

A RarArchive object, opened with rar_open() .

Return Values

Returns the comment or null if there is none.

Note :

RAR has currently no support for unicode commens. The encoding of the result of this function is not specified, but it will probably be Windows-1252.

Examples

Example #1 Object-oriented style

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

The above example will output something similar to:

This is the comment of the file commented.rar.

Example #2 Procedural style

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

add a note

User Contributed Notes

There are no user contributed notes for this pague.
To Top