zip_file_set_comment |
ZIP : Fixe le commentaire du fichier |
|---|---|
| libzip | |
Syntaxe
| int zip_file_set_comment(zip_t *archive, zip_uint64_t index, const char *comment, zip_uint16_t len, zip_flags_t flags); |
Retour
En cas de réussite, 0 est renvoyé. Sinon, -1 est renvoyé et les informations d'erreur dans l'archive sont définies pour indiquer l'erreur.
Description
Cette fonction permet de définir un commentaire pour un fichier dans l'archive ZIP.
Remarque
- La fonction zip_file_set_comment() définit le commentaire du fichier à la position index dans l'archive zip sur un commentaire de longueur len. Si comment est NULL et len ??est 0, le commentaire du fichier sera supprimé. Le paramètre flags peut être l'un des suivants :
| Constante | Description |
|---|---|
| ZIP_FL_ENC_GUESS | Deviner le codage du commentaire (par défaut). (Seuls CP-437 et UTF-8 sont reconnus.) |
| ZIP_FL_ENC_UTF_8 | Interpréter le commentaire comme UTF-8. |
| ZIP_FL_ENC_CP437 | Interpréter le commentaire comme page de code 437 (CP-437). |
Erreurs
zip_file_set_comment() échoue si :
| Constante | Description |
|---|---|
| ZIP_ER_INVAL | index n'est pas un index de fichier valide dans l'archive, ou len est inférieur à 0 ou plus long que la longueur maximale du commentaire dans un fichier zip (65535), ou le commentaire n'est pas une chaîne codée UTF-8 valide. |
| ZIP_ER_MEMORY | La mémoire requise n'a pas pu être allouée. |
| ZIP_ER_RDONLY | L'archive a été ouverte en mode lecture seulement. |
Historique
zip_file_set_comment() a été ajouté dans libzip 0.11.
Voir également
libzip(), zip_file_get_comment(), zip_get_archive_comment(), zip_set_archive_comment()
Dernière mise à jour : Mercredi, le 5 Février 2025