Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

ZIP_SOURCE_GET_ARGS (3)

Name

ZIP_SOURCE_GET_ARGS - validate and cast arguments to source callback

Synopsis

#include <zip.h>

type *
ZIP_SOURCE_GET_ARGS(type, void *data, zip_uint64_t len,
zip_error_t *error);

Description

ZIP_SOURCE_GET_ARGS(3)   BSD Library Functions Manual   ZIP_SOURCE_GET_ARGS(3)

NAME
     ZIP_SOURCE_GET_ARGS -- validate and cast arguments to source callback

LIBRARY
     libzip (-lzip)

SYNOPSIS
     #include <zip.h>

     type *
     ZIP_SOURCE_GET_ARGS(type, void *data, zip_uint64_t len,
         zip_error_t *error);

DESCRIPTION
     The ZIP_SOURCE_GET_ARGS() macro casts data to a pointer to type.

RETURN VALUES
     On success, ZIP_SOURCE_GET_ARGS() returns data.  In case of error, it
     returns NULL and sets error.

ERRORS
     ZIP_SOURCE_GET_ARGS() fails if:

     [ZIP_ER_INVAL]     len is less than the size of type


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_function(3)

HISTORY
     ZIP_SOURCE_GET_ARGS() 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