zip_source_win32handle - man pages section 3: Library Interfaces and Headers

Language:

zip_source_win32handle (3)

Name

zip_source_win32handle - create data source from a Windows file handle

Synopsis

#include <zip.h>

zip_source_t *
zip_source_win32handle(zip_t *archive, HANDLE h, zip_uint64_t start,
zip_int64_t len);

zip_source_t *
zip_source_win32handle_create(HANDLE h, zip_uint64_t start,
zip_int64_t len, zip_error_t *error);

Description

ZIP_SOURCE_WIN32HANDL... BSD Library Functions Manual ZIP_SOURCE_WIN32HANDL...

NAME
     zip_source_win32handle, zip_source_win32handle_create -- create data
     source from a Windows file handle

LIBRARY
     libzip (-lzip)

SYNOPSIS
     #include <zip.h>

     zip_source_t *
     zip_source_win32handle(zip_t *archive, HANDLE h, zip_uint64_t start,
         zip_int64_t len);

     zip_source_t *
     zip_source_win32handle_create(HANDLE h, zip_uint64_t start,
         zip_int64_t len, zip_error_t *error);

DESCRIPTION
     The functions zip_source_win32handle() and
     zip_source_win32handle_create() create a zip source from a Windows file
     handle.  They open fname and read len bytes from offset start from it.
     If len is 0 or -1, the whole file (starting from start) is used.

     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, usu-
     ally by zip_close() or 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 indi-
     cate the error.

ERRORS
     zip_source_w32handle() and zip_source_w32handle_create() fail if:

     [ZIP_ER_INVAL]     fname, start, or len are invalid.

     [ZIP_ER_MEMORY]    Required memory could not be allocated.

     [ZIP_ER_OPEN]      Opening fname failed.


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

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

SEE ALSO
     libzip(3), zip_file_add(3), zip_file_replace(3), zip_source(3),
     zip_source_win32a(3), zip_source_win32w(3)

HISTORY
     zip_source_win32handle() and zip_source_win32handle_create() were 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