Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

zip_source_read (3)

Name

zip_source_read - read data from zip source

Synopsis

#include <zip.h>

zip_int64_t
zip_source_read(zip_source_t *source, void *data, zip_uint64_t len);

Description

ZIP_SOURCE_READ(3)       BSD Library Functions Manual       ZIP_SOURCE_READ(3)

NAME
     zip_source_read -- read data from zip source

LIBRARY
     libzip (-lzip)

SYNOPSIS
     #include <zip.h>

     zip_int64_t
     zip_source_read(zip_source_t *source, void *data, zip_uint64_t len);

DESCRIPTION
     The function zip_source_read() reads up to len bytes of data from source
     at the current read offset into the buffer data.

     The zip source source has to be opened for reading by calling
     zip_source_open(3) first.

RETURN VALUES
     Upon successful completion the number of bytes read is returned.  Upon
     reading end-of-file, zero is returned.  Otherwise, -1 is returned and the
     error information in source is set to indicate the error.


ATTRIBUTES
     See attributes(7) for descriptions of the following attributes:

     +---------------+------------------+
     |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
     +---------------+------------------+
     |Availability   | compress/libzip  |
     +---------------+------------------+
     |Stability      | Volatile         |
     +---------------+------------------+

SEE ALSO
     libzip(3), zip_source(3), zip_source_seek(3), zip_source_tell(3),
     zip_source_write(3)

HISTORY
     zip_source_read() was added in libzip 1.0.

AUTHORS
     Dieter Baron <dillo@nih.at> and Thomas Klausner <tk@giga.or.at>



NOTES
     Source code for open source software components in Oracle Solaris can be
     found at https://www.oracle.com/downloads/opensource/solaris-source-code-
     downloads.html.

     This software was built from source available at https://github.com/ora-
     cle/solaris-userland.  The original community source was downloaded from
     https://libzip.org/download/libzip-1.7.3.tar.gz.

     Further information about this software can be found on the open source
     community website at https://libzip.org/.

BSD                            December 18, 2017                           BSD