www.LinuxHowtos.org

ZIP_SOURCE_FILE

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

BSD mandoc

NAME

zip_source_file zip_source_file_create - create data source from a file

LIBRARY

libzip -lzip)

SYNOPSIS

In zip.h Ft zip_source_t * Fn zip_source_file zip_t *archive const char *fname zip_uint64_t start zip_int64_t len Ft zip_source_t * Fn zip_source_file_create const char *fname zip_uint64_t start zip_int64_t len zip_error_t *error

DESCRIPTION

The functions Fn zip_source_file and Fn zip_source_file_create create a zip source from a file. They open fname and read len bytes from offset start from it.

When passing ZIP_LENGTH_TO_END (or -1, which is deprecated) as len determines the file size when it is called and uses that as the expected file size. If the file size grows between creating and reading from the source, the additional data is ignored. If the file shrinks, libzip treats it as an error ( ZIP_ER_DATA_LENGTH )

When passing ZIP_LENGTH_UNCHECKED as len assumes the file's size is unknown. Reading from the source returns as much data as is there at that time (usually when calling zip_close3).

libzip can do various optimizations if the size of a source is known when it's created, so ZIP_LENGTH_TO_END is preferable. If you deal with files that are likely to change while you are processing them, you can use the less efficient ZIP_LENGTH_UNCHECKED

If the file supports seek, the source can be used to open a zip archive from.

The file is opened and read when the data from the source is used, usually by Fn zip_close or Fn zip_open_from_source .

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_file and Fn zip_source_file_create fail if:

Bq Er ZIP_ER_INVAL: fname start or len are invalid.
Bq Er ZIP_ER_MEMORY: Required memory could not be allocated.
Bq Er ZIP_ER_OPEN: Opening fname failed.

HISTORY

Fn zip_source_file and Fn zip_source_file_create were added in libzip 1.0.

ZIP_LENGTH_TO_END and ZIP_LENGTH_UNCHECKED were added in libzip 1.10.1.

AUTHORS

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