RarArchive::close
RarArchive::getEntries
RarArchive
PHP Manual

# RarArchive::getComment

# rar_comment_get

(PECL rar >= 2.0.0)

RarArchive::getComment -- rar_comment_get — Récupère un commentaire depuis une archive RAR

### Description

Style orienté objet (méthode) :

public string RarArchive::getComment ( void )

Style procédural :

string rar_comment_get ( RarArchive `$rarfile` )

Récupère le commentaire global stocké dans l'archive RAR. Il peut être supérieur à une longueur de 64 Ko.

> Note:

> Cette extension ne supporte pas les commentaires sur de simple entrée.

### Liste de paramètres

`rarfile`

  Un objet RarArchive, ouvert avec la fonction rar_open().

### Valeurs de retour

Retourne le commentaire, ou `NULL` s'il n'y en a pas.

> Note:

> RAR ne supporte actuellement pas les commentaires unicodes. L'encodage du résultat de cette fonction n'est pas spécifié, mais il sera probablement de type Windows-1252.

### Exemples

Exemple #1 Style orienté objet

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

L'exemple ci-dessus va afficher quelque chose de similaire à :

    Ceci est le commentaire du fichier commented.rar.

Exemple #2 Style procédural

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

RarArchive::close
RarArchive::getEntries
RarArchive
PHP Manual