zip_get_archive_comment

Syntaxe

Retour

Une fois l'opération terminée avec succès, un pointeur vers le commentaire est renvoyé, ou NULL s'il n'y a pas de commentaire.

Description

Cette fonction permet de récupérer le commentaire associé à l'archive ZIP.

Remarques

• La fonction zip_get_archive_comment() renvoie le commentaire de l'archive zip entière. La valeur de retour est encodée en UTF-8, sauf si ZIP_FL_ENC_RAW a été spécifié (voir ci-dessous). Ce pointeur ne doit pas être modifié ou libéré (3) et devient invalide lorsque l'archive est fermée. Si lenp n'est pas NULL, l'entier vers lequel il pointe sera défini sur la longueur du commentaire. Si flags est défini sur ZIP_FL_UNCHANGED, le commentaire d'origine inchangé est renvoyé.

De plus, les indicateurs suivants sont pris en charge :

Constante	Description
ZIP_FL_ENC_RAW	Renvoyer le commentaire d'archive non modifié tel qu'il est dans l'archive ZIP.
ZIP_FL_ENC_GUESS	(Par défaut.) Devinez l'encodage du commentaire d'archive dans l'archive ZIP et convertissez-le en UTF-8, si nécessaire. (Seuls CP-437 et UTF-8 sont reconnus.)
ZIP_FL_ENC_STRICT	Suivez la spécification ZIP pour les noms de fichiers et étendez-la au commentaire d'archive, en l'attendant également dans le codage CP-437. Convertissez-le en UTF-8.

ASCII est un sous-ensemble de CP-437 et UTF-8.

Historique

zip_get_archive_comment() a été ajouté dans libzip 0.7. Dans libzip 0.11, le type d'indicateurs a été modifié de int à zip_flags_t.

Voir également

libzip(), zip_file_get_comment()