GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
ZIP_SET_ARCHIVE_COMMENT(3) FreeBSD Library Functions Manual ZIP_SET_ARCHIVE_COMMENT(3)

zip_set_archive_comment
set zip archive comment

libzip (-lzip)

#include <zip.h>
int
zip_set_archive_comment(zip_t *archive, const char *comment, zip_uint16_t len);

The zip_set_archive_comment() function sets the comment for the entire zip archive. If comment is NULL and len is 0, the archive comment will be removed. comment must be encoded in ASCII or UTF-8.

Upon successful completion 0 is returned. Otherwise, -1 is returned and the error information in archive is set to indicate the error.

zip_set_archive_comment() fails if:
[]
len is less than 0 or longer than the maximum comment length in a zip file (65535), or comment is not a valid UTF-8 encoded string.
[]
Required memory could not be allocated.

libzip(3), zip_get_archive_comment(3), zip_get_file_comment(3), zip_set_file_comment(3)

zip_set_archive_comment() was added in libzip 0.7. In libzip 0.11 the type of len was changed from int to zip_uint16_t.

Dieter Baron <dillo@nih.at> and Thomas Klausner <tk@giga.or.at>
December 18, 2017 FreeBSD 12.0-RELEASE

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.