"Fossies" - the Fresh Open Source Software Archive

Member "libzip-1.6.0/man/zip_file_add.html" (24 Jan 2020, 8583 Bytes) of package /linux/misc/libzip-1.6.0.tar.xz:


Caution: In this restricted "Fossies" environment the current HTML page may not be correctly presentated and may have some non-functional links. You can here alternatively try to browse the pure source code or just view or download the uninterpreted raw source code. If the rendering is insufficient you may try to find and view the page on the libzip-1.6.0.tar.xz project site itself.

ZIP_FILE_ADD(3) Library Functions Manual ZIP_FILE_ADD(3)

zip_file_add, zip_file_replace
add file to zip archive or replace file in zip archive

libzip (-lzip)

#include <zip.h>

zip_int64_t
zip_file_add(zip_t *archive, const char *name, zip_source_t *source, zip_flags_t flags);

int
zip_file_replace(zip_t *archive, zip_uint64_t index, zip_source_t *source, zip_flags_t flags);

The function zip_file_add() adds a file to a zip archive, while zip_file_replace() replaces an existing file in a zip archive. The argument archive specifies the zip archive to which the file should be added. name is the file's name in the zip archive (for zip_file_add()), while index specifies which file should be replaced (for zip_file_replace()). The flags argument can be any combination of ZIP_FL_OVERWRITE with one of ZIP_FL_ENC_*:
Overwrite any existing file of the same name. For zip_file_add only.
Guess encoding of name (default).
Interpret name as UTF-8.
Interpret name as code page 437 (CP-437).
The data is obtained from the source argument, see zip_source(3).

NOTE: zip_source_free(3) should not be called on a source after it was used successfully in a zip_file_add or zip_file_replace call.

Upon successful completion, zip_file_add() returns the index of the new file in the archive, and zip_file_replace() returns 0. Otherwise, -1 is returned and the error code in archive is set to indicate the error.

zip_source_t *s;
const char *buf="teststring";

if ((s=zip_source_buffer(archive, buf, sizeof(buf), 0)) == NULL ||
    zip_file_add(archive, name, s, ZIP_FL_ENC_UTF_8) < 0) {
    zip_source_free(s);
    printf("error adding file: %s\n", zip_strerror(archive));
}

zip_file_add() and zip_file_replace() fail if:
[]
There is already a file called name in the archive. (Only applies to zip_file_add(), and only if ZIP_FL_OVERWRITE is not provided).
[]
source or name are NULL, or index is invalid.
[]
Required memory could not be allocated.
[]
Archive was opened in read-only mode.

libzip(3), zip_source(3)

zip_file_add() and zip_file_replace() were added in libzip 0.11.

Dieter Baron <dillo@nih.at> and Thomas Klausner <tk@giga.or.at>
December 18, 2017 NetBSD 9.99.41