www.LinuxHowtos.org

ZIP_SOURCE_ZIP_FILE

Section: C Library Functions (3)
Index Return to Main Contents

BSD mandoc

NAME

zip_source_zip_file zip_source_zip_file_create - create data source from zip file

LIBRARY

libzip -lzip)

SYNOPSIS

In zip.h Ft zip_source_t * Fn zip_source_zip_file zip_t *archive zip_t *srcarchive zip_uint64_t srcidx zip_flags_t flags zip_uint64_t start zip_int64_t length const char *password Ft zip_source_t * Fn zip_source_zip_file_create zip_t *srcarchive zip_uint64_t srcidx zip_flags_t flags zip_uint64_t start zip_int64_t length const char *password zip_error_t *error

DESCRIPTION

The functions Fn zip_source_zip_file and Fn zip_source_zip_file_create create a zip source from a file in a zip archive. The srcarchive argument is the (open) zip archive containing the source zip file at index srcidx length bytes from offset start will be used in the zip_source. If length is -1, the rest of the file, starting from start is used.

If you intend to copy a file from one archive to another, using the flag ZIP_FL_COMPRESSED is more efficient, as it avoids recompressing the file data.

Supported flags are:

ZIP_FL_COMPRESSED: Get the compressed data. This is only supported if the complete file data is requested ( start == 0 and length == -1). This is not supported for changed data. Default is uncompressed.
ZIP_FL_ENCRYPTED: Get the encrypted data. (This flag implies ZIP_FL_COMPRESSED . This is only supported if the complete file data is requested ( start == 0 and length == -1). Default is decrypted.
ZIP_FL_UNCHANGED: Try to get the original data without any changes that may have been made to srcarchive after opening it.

RETURN VALUES

Upon successful completion, the created source is returned. Otherwise, NULL is returned and the error code in archive or error is set to indicate the error.

ERRORS

Fn zip_source_zip_file and Fn zip_source_zip_file_create fail if:

Bq Er ZIP_ER_CHANGED: Unchanged data was requested, but it is not available.
Bq Er ZIP_ER_INVAL: srcarchive srcidx start or length are invalid.
Bq Er ZIP_ER_MEMORY: Required memory could not be allocated.

Additionally, it can return all error codes from Fn zip_stat_index and Fn zip_fopen_index .

HISTORY

Fn zip_source_zip_file and Fn zip_source_zip_file_create were added in libzip 1.10.0.

AUTHORS

An -nosplit An Dieter Baron Aq Mt dillo@nih.at and An Thomas Klausner Aq Mt wiz@gatalith.at