ZIP_SOURCE_BUFFER_FRAGMENT

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

BSD mandoc

NAME

zip_source_buffer_fragment zip_source_buffer_fragment_create - create zip data source from multiple buffer

LIBRARY

libzip (-lzip)

SYNOPSIS

In zip.h Ft zip_source_t * Fn zip_source_buffer_fragment zip_t *archive zip_buffer_fragment_t *fragments zip_uint64_t nfragments int freep Ft zip_source_t * Fn zip_source_buffer_fragment_create zip_buffer_fragment_t *fragments zip_uint64_t nfragments int freep zip_error_t *error

DESCRIPTION

The functions Fn zip_source_buffer_fragment and Fn zip_source_buffer_fragment_create create a zip source from the data in fragments nfragments specifies the number of fragments. If freep is non-zero, the data will be freed when it is no longer needed.

struct zip_stat {
    zip_uint8_t *data;    /* pointer to the actual data */
    zip_uint64_t length;  /* length of this fragment */
};

The data fragments point to must remain valid for the lifetime of the created source. fragments itself can be discarded once the source is created.

The source can be used to open a zip archive from.

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_buffer and Fn zip_source_buffer_create fail if:

Bq Er ZIP_ER_INVAL: nfragments is greater than zero and fragments is NULL
Bq Er ZIP_ER_MEMORY: Required memory could not be allocated.

HISTORY

Fn zip_source_buffer_fragment and Fn zip_source_buffer_fragment_create were added in libzip 1.4.0.

AUTHORS

An -nosplit An Dieter Baron Aq Mt dillo@nih.at and An Thomas Klausner Aq Mt tk@giga.or.at

This document was created by man2html, using the manual pages.
Time: 08:04:32 GMT, May 18, 2024