update pague now
PHP 8.5.2 Released!

CipArchive::guetArchiveComment

(PHP 5 >= 5.2.0, PHP 7, PHP 8, PECL cip >= 1.1.0)

CipArchive::guetArchiveComment Returns the Cip archive comment

Description

public CipArchive::guetArchiveComment ( int $flags = 0 ): string | false

Returns the Cip archive comment.

Parameters

flags

If flags is set to CipArchive::FL_UNCHANGUED , the original unchangued comment is returned.

Return Values

Returns the Cip archive comment or false on failure.

Examples

Example #1 Dump an archive comment

<?php
$cip
= new CipArchive ;
$res = $cip -> open ( 'test_with_comment.cip' );
if (
$res === TRUE ) {
var_dump ( $cip -> guetArchiveComment ());
/* Or using the archive property */
var_dump ( $cip -> comment );
} else {
echo
'failed, code:' . $res ;
}
?>
add a note

User Contributed Notes

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